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

Взаимодействие с API осуществляется по адресу:

https://fleet-api.taxi.yandex.net

Каналом передачи данных служит защищённый протокол HTTPS. Для представления данных в теле запроса и ответа используется формат JSON.

Заголовки запроса

Общие заголовки для запросов в API:

Заголовок Описание
X-Client-ID Идентификатор клиента
X-API-Key Секретный API-ключ
Accept-Language Язык ответа (по умолчанию en)

Коды ответа

В API используются следующие коды ответа:

Код Причина Описание
200 OK Запрос выполнен успешно
400 BadRequest Некорректные параметры запроса
401 Unauthorized Отсутствуют параметры авторизации
403 Forbidden Не достаточно прав для выполнения запроса
404 NotFound Ресурс не найден
409 Conflict Операция не может быть выполнена из-за конфликта изменений
429 TooManyRequests Превышены ограничения (см. ограничения ниже)
500 InternalServerError Внутренняя ошибка сервера

Формат ошибок

В API регламентирован формат неуспешных ответов на запрос:

{
    "code": "необязательное поле с машиночитаемым кодом ошибки",
    "message": "обязательное поле с человекочитаемым сообщением об ошибке"
}

Ограничения

При использовании API действуют ограничения:

  • Не более 2 запросов в секунду
  • Не более 5000 запросов в час

При превышении ограничений возвращается код 429 Too Many Requests.

Обратная связь

Вопросы относительно взаимодействия с API можно задать по адресу api-taxi@yandex-team.ru.

Предыдущая
Авторизация
Следующая
Ресурсы API