Getting Started

Edunation APIs allow developers to request data from Edunation, including (but not limited) to user details, courses, attendance data, as well as perform actions (in the upcoming API release) on the Edunation platform on a user’s behalf. For example, creating a new user or deleting a lesson.

Developers

Only specific developers will be authorized to use Edunation APIs. Once a developer is approved, they will get a client secret, a long alphanumeric generated text that will be sent in the authentication request to get an access token.

API Token

Edunation must authenticate each HTTP request made to the Edunation API. Edunation supports JSON Web Token (JWT) authentication requests.

Each user in Edunation has an API token that he can find in his user profile. API Token is an auto-generated alphanumeric text and unique for each user. The API Token is requested on the authentication process to identify the user trying to log in to load all permissions and account details.

🚧

Warning

As passwords, API tokens can be used to impersonate anyone in the account, including admins. Make sure to keep them secure. Delete any unused tokens. Delete a token at once if you suspect it's been compromised and create another one if necessary.

Authentication

Developers will need to send their client_secret & the api_token for the user they are trying to impersonate. Request header example:

client_secret: {client_secret}
Authorization: Basic {api_token}

The API will return Access Token. This access token will be used in all followed requests to get or post data from/to the API, along with the Client Secret, which must be included in all requests headers. Example:

client_secret: {client_secret}
Authorization: Bearer {access_token}

SSL Requirements

The Edunation API is an SSL-only API. All connections must support the TLS 1.2 protocol (not TLS 1.0 or 1.1).

Rate Limits

The Edunation API is rate limited. Only allow a certain number of requests are allowed per minute depending on your plan and the endpoint. Edunation reserves the right to adjust the rate limit for given endpoints to provide a high quality of service for all clients. For details, see Rate Limits section.