API key
Overview
Route planning API uses an access key for authentication. Pass it in the request using the HTTP POST method and apikey
parameter value.
Note
The use of the key is billable, so make sure only authorized persons know it.
There are two ways to get a key:
-
Using the Yandex Developer Dashboard, a special portal that allows you to generate keys for the APIs of various Yandex services. The key you obtain this way has a limited validity period and some other characteristics.
-
In the web interface of the service (Company section). If you already registered in RouteQ, a key was created automatically and you don't need to get it in Yandex Developer Dashboard. After you pay for the service, the key's validity period is extended.
Getting a key in Yandex Developer Dashboard
-
Log in to Yandex with the username you are going to use with the API.
-
Go to Yandex Developer Dashboard and click Connect APIs.
-
Select Routing: Planning and Track & Trace and click Continue.
-
Fill out the form and click Continue.
-
In the window that opens, click Go to API.
-
The page of your keys for the RouteQ API opens. The created key was activated automatically and can be used.
For more information about managing API keys in Yandex Developer Dashboard, see the documentation.