Make your first request

Get an API key and request a motorcycle route across Kigali from your server.

Open your invited account

Sign in to the customer console. During private beta, request access from the Audisory website if you do not yet have an invitation.

Create a server-side API key

Open API keys, create a key, and store it in your server's secret configuration. Replace YOUR_API_KEY in the examples below. Never include the key in browser code or a mobile application.

Send a route request

The example travels from Kigali city centre toward the airport using the moto profile. The body and snippets below are generated from the API contract.

cURL
curl -X POST 'https://api.uat.audisory.com/v1/directions' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "coordinates": [
    [
      30.0619,
      -1.9441
    ],
    [
      30.1395,
      -1.9686
    ]
  ],
  "profile": "moto"
}'

Inspect the response

Read routes, credits_charged, request_id, and data_version. Distances are metres and durations are seconds. Optional fields may be absent when the underlying data is unavailable.

Continue building

Choose the correct environment

Examples use the API origin for this documentation environment. UAT keys and credits belong to UAT; production credentials belong to production.