Взаимодействие с API

Все API в рамках платформы доступны в формате REST, с понятными и ресурсно-ориентированными URL. Любой ответ API, включая ошибки, возвращается в формате JSON. В случае POST и PUT запросов также необходимо отправлять заголовок application/json или application/x-www-form-urlencoded.

Авторизация#

Любое обращение к платформе требует API-ключ. Для удобства использования вы можете иметь множество API-ключей и управлять ими в разделе Мои токены. Ваш API-ключ должен передаваться в заголовке Authorization с каждым запросом.

Sample request#

curl https://maps.starline.ru/api/geocoder/v1/forward?query=starline \  -H "Authorization: bearer ..."

Ошибки#

Все API платформы используют стандартные HTTP-коды.

Коды ошибок#

200: Успешный запрос
400: Некорректный запрос (отсутствуют параметры или параметры заданы неверно)
401: Неавторизованный запрос (неверный API ключ)
402: Требуется оплата (вы превысили объем потребления по вашему тарифу)
403: Доступ запрещен (недостаточно прав)
404: Объект не найден
429: Слишком много запросов (превышено количество запросов в минуту)
500: Внутренняя ошибка сервиса
503: Сервис временно недоступен

Версионирование#

Все API платформы подвержены версионированию. Текущая версия всех API — 1, все последующие версии будут доступны с увеличением значения. Обратная совместимость сохраняется на последние 2 версии. То есть, если выходит новый API геокодера под версией 3, то платформа сохраняет поддержку версий 2 и 3.

Расширение API#

Мы очень внимательно относимся к потребностям наших пользователей. В случае если вам не хватает какого-то функционала или даже отдельного API, то напишите нам через форму обратной связи.