API построения оптимальных маршрутов

HTTP API предназначен для автоматического распределения заказов по курьерам (транспортным средствам или пешим сотрудникам) и построения маршрутов доставки. Заказы распределяются с учетом их веса, объема, интервалов доставки, расходов на транспортировку и других параметров. Помимо этого доступна возможность построения и обновления маршрута для одного курьера.

При построении маршрута учитывается дорожная ситуация (прогноз пробок, перекрытые дороги и другое). Данные о дорожной ситуации предоставляются сервисом Яндекс.Карты.

  1. Способы маршрутизация
  2. Принцип работы
  3. Базовый путь
  4. Ограничения
  5. Тарифы
  6. Подключение

Способы маршрутизация

Доступны два способа маршрутизации:

Для нескольких курьеров

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

Поиск оптимального маршрута может занимать от нескольких секунд до нескольких минут в зависимости от количества заказов.

Для одного курьера

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

Принцип работы

API работает асинхронно, потому что планирование маршрута может занять несколько минут. Работа с API организована следующим образом:
  1. C помощью POST-запроса ставится задача на маршрутизацию. Формат запроса доступен в спецификации сервиса.
  2. После получения задачи, сервис маршрутизации начинает обработку запроса.
  3. С помощью GET-запроса получается текущий статус обработки задачи.
    • Если задача еще обрабатывается, API вернет информацию о текущем статусе.
    • Если задача обработана, API вернет построенные маршруты в формате JSON.
    Формат ответа доступен в спецификации сервиса.

Базовый путь

API расположен по следующему адресу:
https://courier.common.yandex.ru/vrs/api/v1

Ограничения

В API ограничено количество заказов в одном запросе:

  • При маршрутизации для нескольких курьеров нельзя использовать более 1000 заказов.
  • При маршрутизации для одного курьера нельзя использовать более 250 заказов.

Тарифы

Информация об актуальных тарифах доступна на странице сервиса.

Подключение

Для работы c API необходим лицензионный ключ. Чтобы получить ключ, заполните заявку на подключение.