Запрос API

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

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

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

Структура JSON

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

Запрос API

Ниже приведен пример запроса для утилиты командной строки cURL.

curl -X POST "https://courier.yandex.ru/vrs/api/v1/calendar_planning/tasks?apikey=<my-api-key>" -d @task.json

где my-api-key — ключ API. В заголовке запроса X-YaCourier-Signature должна передаваться подпись.

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

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

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

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

Коды ответов

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

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