Eduframe - API (v1)

For authenticating through Eduframe API v1 we use OAuth2 token. The user needs an API key to send together with the request as Bearer <api key> in the authorization header. If there are requests that require authentication a 403 Forbidden error or a 404 Not Found error will be returned.

For sorting the data, the following format of base_url is used (e.g.): api/v1/planned_courses?sort=start_date for ascending sort (default sorting) and api/v1/planned_courses?sort=start_date:desc for descending sort.

For adding a filter, the following format of base_url is used (e.g.): api/v1/planned_courses?min_cost=200. The allowed filters are shown at the relevant actions.

Blank fields are included as null.

All boolean parameters can be passed as true, false, 1 or 0. And are returned as true or false.

Some requests generate timestamps (a timestamp is generated at the moment the API call is made) or allow specifying them. All timestamps are returned in ISO 8601 format: yyyy-MM-ddTHH:mm:ss.SSSZ. If providing a date, just make sure you follow the same ISO standard.

For each request the appropriate HTTP verbs are used. GET is used for retrieving resources, POST is used for creating resources, PUT is used for updated resources with partial JSON data. A PUT request can accept one or more parameters to update the resource; the parameters that are not updated keep their original values, DELETE is used for deleting resources.

Requests that return multiple items will be paginated to 25 items by default. You can select a page with the page query parameter. When omitted, the first page is returned by default. You can set a custom per-page amount with the per_page query parameter (with a maximum of 100). The Link header includes pagination information. For example: Link: <https://api.eduframe.nl/courses?page=3&per_page=100>; rel="next", <https://api.eduframe.nl/courses?page=50&per_page=100>; rel="last"

In the Eduframe API the general codes are: the 2xx range indicates a successful request; the 4xx range indicates an error representing the failure of giving the provided information(e.g. a required parameter was omitted, a certain include/filter is not allowed, unauthorized access, etc.); the 5xx range indicates an error with the Eduframe's servers.

Webhooks allow you to build or set up integrations, such as Azure Logic Apps, which subscribe to certain events on Eduframe. When one of those events is triggered, we will send a HTTP POST payload to the webhook's configured URL. More info can be found at the webhooks documentation. Eduframe has a 10-second timeout for each webhook sent, which means you want to make sure you have returned a response before this time limit elapses. If traffic spikes and you don't respond quickly, you begin to accumulate a backlog of webhooks and may start dropping some.