Introduction

You can use the Route4Me API to address many different business needs. In these tutorials, we'll be using real-world examples to show what our API can do for you.

These tutorials will be updated regularly. If you have any questions or comments about the Route4Me API, feel free to send them to: suppo[email protected][email protected][email protected]oute4[email protected]me.c[email protected]om.

Helper Libraries

You won’t have to deal with any language barriers when you use the Route4Me API, as it can be translated into 13 different programming languages. The following SDK's are maintained by Route4Me:

HTTP Verbs

The Route4Me API uses the following HTTP verbs:
Verb Description
GET Used for retrieving resources
PUT Used for updating resources
POST Used for creating resources
DELETEUsed for deleting resources

Making Requests

POST requests must have a JSON-encoded body and the JSON content type 'application/json header'.
GET requests have parameters provided in the query string.
All requests must be made over HTTPS.
Note
All GET query string parameters should be URL-encoded.

Responses

Responses are almost always JSON-encoded. A few of them, though, are XML-encoded.
Each API response contains:
  • Success - a boolean indicating whether the call was successful or unsuccessful.
  • Message - an error message if the API call failed, "Success" if otherwise.
  • Response - the actual data returned by the API call.

Authentication

Every Route4Me SDK instance requires a unique API key. The API key can be retrieved from inside your Route4Me account. To find it, go to ‘Settings’ and select the ‘API’ tab.

Make sure to replace 11111111111111111111111111111111 with your API key.

You can also obtain your API key by going to ‘My Account’ –> ‘API menu item’.

Contents