Welcome to the Symtrain Public APIs documentation! Our APIs are designed to empower your training platform with seamless access to powerful data and insights. Whether you're generating reports, managing simulation assignments, or onboarding users, our APIs enable you to integrate Symtrain's advanced capabilities into your systems effortlessly.
This documentation will guide you through the process of utilizing the Symtrain APIs, providing you with the tools needed to enhance performance, improve user experience, and drive better results.
Getting Started
Before you start integrating Symtrain’s APIs into your system, here are the essential steps to ensure a smooth experience:
Prerequisite
- API Key: To interact with the Symtrain Public APIs, you’ll need a valid API Key. This key serves as your authentication method, allowing secure access to our API services. If you don’t have an API key yet, reach out to our support team ([email protected]) to obtain one.
Using Your API Key
Once you have your API Key, you'll use it in the header of your API requests. Here's an example of how to include it:
Code
It’s crucial to keep your API Key secure and never expose it publicly. This key ensures that your API calls are authenticated and routed to the correct organization.
Additionally, Symtrain uses token-based authentication, this token is directly associated to the organization(s), ensuring restricted access to the data.
Rate Limiting
To ensure fair use and prevent overload, we apply rate limiting on our APIs. Typically, there is a limit of 100 requests per 5-minute window-span for each IP. Exceeding this limit will result in a 429 Too Many Requests response.
Error Handling
The API will return detailed error messages for failed requests. Common error codes include:
- 400: Bad Request – Invalid data or missing parameters.
- 401: Unauthorized – Invalid or missing API key.
- 403: Forbidden – Insufficient permissions to access the resource.
- 404: Not Found – Resource not found.
- 500: Internal Server Error – Server-side issue.
API Overview
Symtrain's Public APIs are designed to help organizations integrate their platforms with our system. We offer two versions of our API:
🆕 API Version 2 (Recommended)
Our latest API version with enhanced features and additional endpoints. We recommend all new integrations use v2.
- Reports API: Enhanced APIs with additional data points for performance and result-based reports
- Access API: Improved endpoints to generate simulation deep-links, manage simulation assignments, and retrieve comprehensive simulation data
API Version 1
Our stable v1 API continues to be supported for existing integrations.
- Reports API: APIs that allow you to fetch various performance and result-based reports
- Access API: Endpoints to generate simulation deep-links and query execution scores
Quick Links
- 📖 API v2 Reference - Interactive API documentation for v2
- 📖 API v1 Reference - Interactive API documentation for v1
Choose Your API Version
Starting a New Integration?
👉 Use API Version 2 - Our latest version with enhanced features and additional endpoints.
Already Using v1?
✅ Your integration continues to work. Consider migrating to v2 for new features.
Quick Start Workflow
Here's a simple 5-step workflow to get started with the Symtrain APIs:
1. Authenticate 🔐
Obtain your API key from support and include it in request headers:
Code
2. Get Available Simulations 📚
Retrieve the list of simulations from your library:
Code
3. Assign Simulation 🎯
Assign a simulation to a specific user:
Code
4. Generate Access Token 🎫
Create a user-specific token for secure access:
Code
5. Get Results 📊
Retrieve performance data and reports:
Code
See detailed workflows in the API v2 Guide and Tutorials.
Need Help?
For any questions or issues, don't hesitate to contact our support team at: [email protected]