Introduction

Eduframe has API documentation available in both textual or openapi format. Also we provide an php client that allows you to easily connect to the Eduframe API. This client is available on github.

Create an API key

An API key is a token that gives access to the data in your system. Since a website developer needs to import data from the backend system into the website he needs access to the data in your administration. You can create a key by logging into Eduframe and go to your name in the navigation bar. Then click on the my profile button. On the next screen click on the button add access token. Give the access token a clear description so you always know for what purpose it was created, and with whom it was shared. Then fill in the date until the access token is valid, and choose to which data the access token provides access.

The following scopes are often used:

• courses:read
• teachers:read (when for example want to communicate teachers to the website)
• leads:modify (when you want to create opportunities from the website)