API информации о регионе

Запрос позволяет получить информацию о тарифах и услугах Яндекс Go в указанном регионе.

Синтаксис запроса

GET  https://taxi-routeinfo.taxi.yandex.net/zone_info?clid=<clid>&apikey=<apikey>&ll=<lon,lat>

Аргументы:

  • clid — идентификатор клиента. Чтобы получить идентификатор, заполните анкету на странице API прогноза стоимости. Обязательный параметр.

  • apikey — ключ API. Чтобы получить ключ, заполните анкету на странице API прогноза стоимости. Параметр может быть использован вместо заголовка YaTaxi-Api-Key. Если не был передан заголовок YaTaxi-Api-Key, параметр apikey является обязательным.

    Внимание

    Данный способ не рекомендуется к использованию, так как значение токена может сохраняться в логах.

  • ll — координаты региона. Обязательный параметр. Формат аргумента:

    {долгота региона},{широта региона}

Описание полей ответа

В ответе могут содержаться следующие поля:

Поле

Описание

Формат

tariffs

Список тарифов, поддерживаемых в регионе. Если указанный регион не поддерживается сервисом Яндекс Go, массив будет пустым.

Массив.

class

Идентификатор тарифа. Возможные значения:

  • econom — «Эконом».
  • business — «Комфорт».
  • comfortplus — «Комфорт+».
  • minivan — «Минивен».
  • vip — «Бизнес».
  • express — «Доставка».
  • courier — «Курьер».

Строка.

supported_requirements

Список услуг, предоставляемых в регионе.

Массив.

name

Идентификатор услуги. Возможные значения:

  • yellowcarnumber — машина с желтыми номерами.
  • nosmoking — некурящий водитель.
  • childchair — наличие детского кресла в машине.
  • bicycle — перевозка велосипеда.
  • conditioner — кондиционер в машине.
  • animaltransport — перевозка животных.
  • universal — машина-универсал.
  • check — необходима квитанция об оплате.
  • ski — перевозка лыж или сноуборда.
  • waiting_in_transit — ожидание в пути.
  • meeting_arriving — встреча с табличкой.
  • luggage — платная перевозка багажа.

Строка.

Пример запроса

GET https://taxi-routeinfo.taxi.yandex.net/zone_info?ll=37.589569560,55.733780&clid=t...t3&apikey=q...3

Пример ответа

Пример ответа на запрос информации о регионе выглядит следующим образом:

{
    "tariffs": [
        {
            "class": "econom", 
            "supported_requirements": [
               {
                  "name": "conditioner" 
               },
               {
                    "name": "childchair"
               },
               ...
            ]
        }, …
    ]
}

Возможные коды ответа

Ответ на данный запрос может содержать следующие коды ответа:

  • 200 — запрос выполнен успешно.
  • 400 — параметры запроса были не указаны или указаны некорректно.
  • 403 — ошибка авторизации. Были указаны некорректные значения ключа API или идентификатора клиента.
  • 500 — внутренняя ошибка сервера.

В случае ошибок с кодами 400 и 403 в теле ответа будет содержаться текст сообщения об ошибке.

Список тарифов, поддерживаемых в регионе. Если указанный регион не поддерживается сервисом Яндекс Go, массив будет пустым.

Идентификатор тарифа. Возможные значения:

  • econom — «Эконом».
  • business — «Комфорт».
  • comfortplus — «Комфорт+».
  • minivan — «Минивен».
  • vip — «Бизнес».
  • express — «Доставка».
  • courier — «Курьер».

Список услуг, предоставляемых в регионе.

Идентификатор услуги. Возможные значения:

  • yellowcarnumber — машина с желтыми номерами.
  • nosmoking — некурящий водитель.
  • childchair — наличие детского кресла в машине.
  • bicycle — перевозка велосипеда.
  • conditioner — кондиционер в машине.
  • animaltransport — перевозка животных.
  • universal — машина-универсал.
  • check — необходима квитанция об оплате.
  • ski — перевозка лыж или сноуборда.
  • waiting_in_transit — ожидание в пути.
  • meeting_arriving — встреча с табличкой.
  • luggage — платная перевозка багажа.

clid — идентификатор клиента. Чтобы получить идентификатор, заполните анкету на странице API прогноза стоимости.

apikey — ключ API. Чтобы получить ключ, заполните анкету на странице API прогноза стоимости. Параметр может быть использован вместо заголовка YaTaxi-Api-Key. Если не был передан заголовок YaTaxi-Api-Key, параметр apikey является обязательным.

ll — координаты региона. Обязательный параметр. Формат аргумента:

{долгота региона},{широта региона}
Предыдущая
API информации о поездке
Следующая
Продвинутое формирование ссылок на заказ