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.

tip

Don't forget to read the Considerations chapter too!

You can create a new API key using these steps:

1. Click on your name in the navigation bar after logging into Eduframe.
2. Click on My profile -> Add access token.
3. 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.
4. Save the form and you will receive you access token. Copy this token immediately since you will only see it once.

Considerations

API keys in Eduframe are bound to a specific person. When you require an API key for important integrations (like your website) we recommend creating a separate user (which you can call 'Website' for example) that will manage these important API keys. If you don't, you might break you're integrations when removing users/restricting their access to Eduframe.

To create a new user, follow these steps:

1. Go to Settings -> Administrators -> Create new administrator.
2. Create a new administrator with a clear name (for example: Website)
3. Login using this new administrator.
4. Follow the steps under Create an API key to obtain your API key.

The following scopes are often used:

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

tip

Scopes are useful to limit the actions possible using a generated key. We recommend using it to improve security.