Introduction to the Springest API
We've written some example scripts in PHP and Ruby in case you find it hard to get started.
For each country that we operate in, our API is accessed through a different host. You'll need a separate API key for each host.
| Our API is as stated per country and not per domain
so it Is possible to call the Go Domains of that country.
Per Go always use 'nameofgo.api.go.host'
See example of our Dutch demo Go domain.
|Products - courses, training, elearning and associated data|| Institutes - data on education providers
|Categories - the main ~21 categories Springest is categorised in||Subjects - ~1000 specific subjects Springest is divided in|
|Reviews - ratings and reviews per course or institute||Conversions - course bookings and information requests for providers|
|LearnMatch job / article matching - our "magic" matching API that returns relevant courses based on your input||Certificates and certifications - user certificates and the certifications they belong to.|
|Features with limited access:|
|Bookings - Create bookings in our system|| Webhooks for Conversions End point - Use webhooks to get latest updates per site for conversions
|Autocomplete (search suggestions) - Create a "quick search" widget in your intranet.||Webhooks for Trainings End point - Use webhooks to get latest updates per site for trainings (mainly for courseboards etc)|
|Users - Create user accounts||Cancel bookings - cancel bookings made in our system|
Supported data formats
We provide both XML and JSON formatted data. Pick your preferred output format by changing the extension of your request to either
.json.For brevity we've used only XML output in the examples in this documentation
Response status codes
While using our API you can encounter the following response status codes:
||The request was correct|
||You either tried to request an invalid resource, or used a parameter incorrectly|
||You need to supply valid authentication credentials (ie. an API key)|
||You don't have the right privileges to access this method|
||The resource that you try to reach does not exist|
||The method received in the request-line is known but endpoint most likely not existing/correctly called|
||Something went wrong on our side|
Authentication is fairly simple with an API key that you can request from us.
Please append your API key to every request you make, e.g.
Please be aware that we've capped the amount of requests you can make to our API to 4000 requests per hour.
Not all data is accessible through the API. Additionally, depending on the type of partnership, certain fields will not be accessible.
All the requests that have multiple results are paginated. You can set the page size by adding the
size parameter to your request, e.g. to return 12 items per page, make the following request:
You can set the page you need with the
offset parameter, e.g. to get the third page of a list of institutes, using a page size of 12 institutes per page, make the following request:
||Used to indicate starting point of pagination|
||Number of results per page|
- Means text that needs to be replaced by your own data
- Means that something is optional
- Your name and email address
- The name of your organization
- The URL of your organization
- What you would like to do with our API
If you'd like to request an API key please send an email to firstname.lastname@example.org with the following details: