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' -> 'Customization' -> '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. |
The functionality provided focuses on performing tasks meaningful for a remote service, such as user creation, course assignment, listing courses, etc. In addition, one can use the API to provide basic SSO for users.
To ease the implementation of services, we provide an SDK library for PHP that automates the tasks of communicating with the API. The first part of this guide provides a detailed description of the available API calls, as well as information on authentication and error handling. The second part of the guide demonstrates the use of the PHP SDK, providing information on setting it up and performing some basic tasks.
You can download the eFront SDK and read the related documentation on SwaggerHub.