What you'll need to know to get started using eduMe's public API
Requirements for using the public API
In order to get started using eduMe's public API, first you'll need:
- To be a customer of eduMe. Currently we only support active customers of eduMe with API credentials to test and build with. If your organisation is currently reviewing eduMe, then please feel free to get in touch with any questions you may have on our developer community.
- To have an API key at either a group or company level. If your organisation is a customer of eduMe and you want to set up your API key, please reach out to your Customer Success Manager or firstname.lastname@example.org who will be able to share this with you.
- To have the necessary parameters you require for the API call you'd like to use. The API docs are the best way to identify the parameters required and will also guide you to where you can find the parameters for your query.
How to use the public API
Here we will complete a simple API call step-by-step:
Select the API request you want to make. We will use the Health Check API: https://edume.docs.apiary.io/#reference/status/health-check
Use your preferred method for calling public APIs. Some of our developers try these out using tools like postman to get started.
Add the header `x-api-key: YOUR_API_KEY` where `YOUR_API_KEY` is the API key you will find in your company settings
No parameters or body is required for this specific API
You should receive the following response:
If you didn’t receive the response above and instead receive:
"message": "Invalid API key",
"error": "Invalid API key"
Then your API Key is invalid; please check that you have the right one.
Here is a short video outlining the steps above:
In the clip below, we follow up by calling one of our most popular endpoints Progress Stats Progress CSV for Course Progress. This endpoint provides course completion data by the user and can be used in conjunction with course completion Webhook to ensure no user blocking flows within an advanced integration.
You can find more documentation in our apiary
Postman is an API platform for building and using APIs.