API Access Notes
- The API is only accessible using a secure HTTP connection
- The API Key is your access token to use the service. It must
be sent using the request parameter "apiKey" in each of
- The current installation is a test setup which means that
you can use the API freely to add and modify documents.
- The URL, Client ID and API Key will be different on your
production installation of the API so make sure it is easy for you
to change these in your code.
API Usage Notes
- The JSON Objects are unordered which means that the
order of the various fields may change.
- If a query to the API returns several Objects, the result is
also unordered, which means that several identical calls
will yield the same results but not necessarily in the same order.
- Optional fields that are empty will not appear in a JSON
Object when getting them from the API.
API Calls vs. Admin Labels
You might have noticed that the API calls in the different
documentation pages do not match the fields that you can see when you
navigate the administration interface. Call
to get some idea about the relations between the two.
On success, every call will return a HTTP 200 return code (or
304, if appropriate) along with a call-specific data structure.
On error, every call will return an appropriate HTTP status
code and the following JSON structure.
Example Error Object
error : "ERROR_NAME",
message : "Some message",