Authentication

Requests to the Despatch Cloud API must authenticate using an API key.

By default, a Despatch Cloud account doesn't have an API key. You can create an API key in Settings under "General Settings" > "Web Service".

The client can authenticate itself by sending an appropriate HTTP request header.

The header's name should be Authorization: and its value should be DC followed by your API key.

Authorization: DC YOUR-API-KEY

Authorization: DC AE5A7FA6E44C50C3AA7023EAB4BBD026

The above is an example using API key "AE5A7FA6E44C50C3AA7023EAB4BBD026".

Example Request:

CopyCopycurl --header "Authorization: DC YOUR-API-KEY" https://YOUR-ACCOUNT-NAME.despatchcloud.co.uk/ws/v1/wsorders/create_order/

Example Response:

CopyCopy{"status":"SUCCESS","order_id":"1529938140-52"}