Introduction to the Springest API

The Springest API is a REST-ful API. This documentation will explain you how you can communicate with it. If you have any problems or requests, please do contact us.

We've written some example scripts in PHP and Ruby in case you find it hard to get started. It's very basic though.

Hosts

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.

Country Host address
Netherlands https://api.springest.nl
United Kingdom https://api.springest.co.uk
Belgium (Flanders) https://api.nl.springest.be
Germany https://api.springest.de
Global https://api.springest.com

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 .xml or .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:

Status Description
200 OK The request was correct
400 Bad Request You either tried to request an invalid resource, or used a parameter incorrectly
401 You're not authorized You need to supply valid authentication credentials (ie. an API key)
403 Forbidden You don't have the right privileges to access this method
404 Not Found The resource that you try to reach does not exist
500 Server Error Something went wrong on our side

Authentication

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. GET /trainings/1234.xml?api_key=YOURAPIKEY

Rate limiting

Please be aware that we've capped the amount of requests you can make to our API to 4000 requests per hour.

Access Levels

Not all data is accessible through the API. We currently recognize two different access levels: minipartner and mediapartner, meaning minipartners have restricted access to some fields.

Pagination

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: GET /institutes.xml?size=12&api_key=YOURAPIKEY

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: GET /institutes.xml?size=12&offset=24&api_key=YOURAPIKEY

Pagination parameters
Parameter Type Required Values Default Description
offset Integer No x > 0 0 Used to indicate starting point of pagination
size Integer No 1 <= x <= 30 10 Number of results per page

Documentation conventions

{text}
Means text that needs to be replaced by your own data
<text>
Means that something is optional

Nog hulp nodig? Neem contact met ons op Neem contact met ons op

Laatst aangepast op Oktober 13, 2014