eFront provides a comprehensive REST JSON API that allows interaction with remote services.
Authentication is based on an API key that is defined under your installation’s system settings. In order to enable the API and get your key, go to the 'System Settings' -> 'Integrations' -> API tab (1). Click to Enable the API (2) and get your key (3).
| Note: You can click on the refresh icon (4) in order to set a new API key and deprecate the old one. |
API Basics
Once the API is enabled, you can begin making calls to perform useful operations, such as:
- Creating users and assigning them to courses
- Listing courses, users, groups, and categories
- Checking or updating user status in courses
- Handling SSO through auto-login
You can interact with the API using tools like curl, Postman, or any HTTP client of your choice.
Quick Start Example with cURL
curl -X GET "https://<your-domain>/API/v1.0/System/Info" \
-H "Accept: application/json" \
-H "Accept-Language: en_US" \
-u "<MY_API_Key>:"Replace <MY_API_KEY> with your actual API key. The colon (:) after the key is required.
API Authentication
All eFront API endpoints require authentication using your private API key. There are no public endpoints.
Use Basic Authentication with your API key:
curl -X GET "https://<your-domain>/API/v1.0/..." \
-H "Accept: application/json" \
-H "Accept-Language: en_US" \
-u "<MY_API_Key>:"Make sure to:
- Keep the colon : after the API key
- Use the correct domain and versioned API endpoint (e.g., /API/v1.0/)
API Error Handling
Every API response includes a success field:
- "success": true means the call was successful
- "success": false indicates an error
HTTP status codes also provide helpful context:
| Status Code | Description |
| 200 | The request was successfully processed |
| 400 | General bad request or unprocessable action |
| 401 | Authentication required or failed |
| 403 | Forbidden. The request was valid, but you don’t have permission to access the requested resource |
| 404 | Invalid endpoint or entity not found |
| 405 | Invalid HTTP method (only GET, POST, PUT supported) |
| 503 | Service unavailable (API is disabled) |
Error responses may also include:
- an error code
- a human-readable message
- an optional technical reason
Explore All API Endpoints
To explore available API endpoints, required parameters, and expected responses, visit the official API documentation below:
This interactive reference helps you test endpoints, view live request/response examples, and streamline your integration with eFront’s API.