Getting Started
The Divendo API opens up a world of possibilities for integrating our platform with your favourite software.
Our REST API allows you integrate with websites powered by the Divendo platform using simple HTTP methods, in either XML or JSON formats, making this an ideal API for developing mobile applications or external clients.
Here are some of the benefits of using the REST API in your integrations:
- Ubiquitous access: You can use standard HTTP method call-outs, available on every language and platform, to make requests and retrieve information from Divendo.
- Standards-based security: Utilize HTTP Headers for authenticating your REST calls.
- Flexible formats: The REST API supports both an XML serialization as well as the JSON format.
Getting your API Key
In order to utilise Divendo's API, you will first need an active API Key which must be supplied with every input request that you make (see authentication).
If you're an existing client, you can simply request an API Key from your account manager or alternatively raising a support request via your dedicated client access portal.
If you're a new to Divendo, a third-party, or working on behalf of one of our clients - you can simply request an API Key via our developer network scheme.
Authentication
The Divendo API requires the “X-API-AUTH” HTTP Header in order to authenticate requests, the content of which must be a valid API access key for the website that you are communication with.
You are able to test calls using a command line tool like cURL (which will also allow you to make requests which require the use of the POST, PUT and DELETE HTTP verbs).
curl https://www.mystore.com/restapi/locations.json -H "X-API-AUTH:apikey"HTTP Request
GET /restapi/locations.json HTTP/1.1
User-Agent: curl/7.24.0 (x86_64-apple-darwin12.0) libcurl/7.24.0
OpenSSL/0.9.8r zlib/1.2.5
Host: www.mystore.com
Accept: */*
X-API-AUTH:apikeyHTTP Response
HTTP/1.1 200 OK
Cache-Control: no-cache, no-store, must-revalidate
Pragma: no-cache
Content-Length: 5050
Content-Type: application/json; charset=utf-8
Expires: -1
Access-Control-Allow-Origin: *
Date: Wed, 10 Oct 2012 22:29:57 GMT
[{"ID":1,"Code":"001","Name":"Birmingham","Manager":"","Email":"bimingham@lifecycles.co.uk","Telephone":{"Daytime":"0203 086 9860","Evening":"","Mobile":""},"Address":{"Title":"","Firstname":"","Surname":"","AddressLine1":"Park Lane","AddressLine2":"","Town":"Wednesbury","County":"West Midlands","Postcode":"WS10 9SF","Country":"GB"}}]