API Reference

API Reference

Authentication

The Waygo API uses API keys for authentication. You can create an API key in the Waygo Dashboard (coming soon), or by contacting Waygo support at support@waygomaps.com.

The Waygo-API-Key special header must be added to all requests (other than login) to properly authenticate each request.

Be sure to keep your API keys secure and do not share them with anyone. Refrain from embedding API keys in client-side code, on GitHub, or in other public repositories.

Authenticated Request (cURL)

curl https://api.waygomaps.com/maps/v1 \
    -H "Waygo-API-Key: eyJhbGciOiJIU...sXSJE_1AJgMEnI_g-WTerk"

All API requests must be made over HTTPS. Requests made over HTTP, or with invalid or expired API keys will be rejected with an error.

Sub-Account Authentication

A Waygo API key can be used to make requests on behalf of its associated account, or on behalf of any of its sub-accounts.

If making a request on behalf of a sub-account, you must specify the Waygo account ID of the sub-account using the Waygo-Account special header. However, if you are making a request for the main associated account, you do not need to specify the Waygo-Account special header, as the API key is already associated with the main account.

Authenticated Sub-Account Request (cURL)

curl https://api.waygomaps.com/maps/v1 \
    -H "Waygo-API-Key: eyJhbGciOiJIU...sXSJE_1AJgMEnI_g-WTerk" \
    -H "Waygo-Account: n33f9h0fh9324hf9h439fh9h2f9h93h9"