You are here:

API Overview

Our API is a low REST API. There are basically two types of methods:

  • methods that only retrieve data – they use the GET HTTP method and all parameters are part of the URL.
  • methods that change data (updates or inserts) – they use the POST HTTP method. Some parameters are part of the URL and some parameters are specified in the content of the HTTP request.

Our API is based on the industry standard OAuth protocol for authentication and authorisation. You’ll need to get your head around OAuth, and you’ll need the permission of the user.

The remaining pages in this section cover topics that explain how to register your application with us, how to test your app, how we do authentication and authorisation, rate limiting, error reporting and caching.