Запрос API

Подготовка исходных данных

Подготовьте исходные данные в формате JSON с учетом особенностей и ограничений.

Используйте параметры, описанные в разделе Справочник параметров. Убедитесь, что в запрос включены обязательные параметры, признак обязательности указан в справочнике.

Структура JSON

{
    "locations": [
        // Описывает локации.
    ],
    "employees": [
        // Описывает мобильных сотрудников.
    ],
   "options": {
        // Описывает опции планирования.
    },
    "zones": [
        // Описывает геозоны (необязательный объект).
    ]
}

Запрос API

Пример запроса для утилиты командной строки cURL с авторизацией через API-ключ:

curl -H "Content-Type: application/json" -X POST -d <тело запроса> https://courier.yandex.ru/vrs/api/v1/calendar_planning/tasks?apikey=<ваш API-ключ>

В параметрах строки запроса вместо <ваш API-ключ> укажите полученный API-ключ.

Вместо <тело запроса> укажите исходные данные в формате JSON. Для файлов используйте префикс @. Например, @task.json.

Ответом должно быть сообщение:

202 Accepted
{
    "id": "task_id",
    "status": "queued",
    "message": "Task queued"
}

Параметры запроса

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

Коды ответов

Остановить задачу планирования

Чтобы остановить задачу планирования до ее завершения, отправьте запрос к ресурсу cancel.

В запросе укажите:

• id — ID задачи;
• apikey — API-ключ, который указан в настройках компании. Подробнее об API-ключах см. в разделе Ключ API.

Запрос:

curl -X POST https://courier.yandex.ru/vrs/api/v1/calendar_planning/tasks/<id-задачи>/cancel?apikey=<API-ключ-компании> -H "Content-Type: application/json" -H "Authorization: OAuth <ваш-OAuth-токен>"

Анализ полученного решения

Типичные ошибки, возвращаемые запросом API, описаны в разделе Обработка ошибок.