Авторизация
Авторизация в сервисе Яндекс Маршрутизации производится через Яндекс ID. Для учетной записи Яндекс Маршрутизации рекомендуется соблюдать правила защиты аккаунта.
Для получения доступа учетная запись или Яндекс ID должны быть привязана к определенному ID компании. Учетная запись может быть привязана только к одной компании, но компания может содержать несколько учетных записей. Если ID компании уже существует, то добавить новых пользователей может администратор компании. Если создать новую компанию, то учетная запись, под которой был авторизован пользователь при создании компании, будет добавлена в качестве администратора.
Примечание
При работе с учетными записями:
-
Используйте для регистрации компании отдельный email, который не используется в личных целях. Это поможет сохранить доступ к компании, например, при увольнении сотрудника. Дополнительная информация в разделе Перед регистрацией.
-
Создавайте отдельные учетные записи для разных пользователей, чтобы сотрудники не потеряли доступ, если кто-то изменит пароль для учетной записи.
От того, какие функции Маршрутизации вы планируете использовать, зависит схема авторизации:
-
Для планирования маршрутов только через интерфейс, достаточно ID компании и учетной записи, которая привязана к данной компании. Подробнее см. в разделе Регистрация.
-
Чтобы использовать API Планирования, необходим ключ API.
-
Чтобы использовать API Мониторинга и некоторые функции API Планирования (например, Геозоны из справочника и публичные геозоны), необходим OAuth-токен.
Взаимосвязь объектов
Ключ API
Общие сведения
Для аутентификации в API планирования маршрутов используется ключ доступа. Его нужно передавать в запросе c HTTP-методом POST как значение параметра apikey.
Примечание
По ключу ведется тарификация, поэтому его должны знать только доверенные лица.
Получить ключ можно двумя способами:
-
Через Кабинет Разработчика — специальный портал, который позволяет генерировать ключи для API различных сервисов Яндекса. Полученный таким образом ключ будет иметь ограничения по сроку действия и некоторым другим характеристикам. После получения ключа для доступа к Рабочему месту логиста необходимо связаться с менеджером.
-
В веб-интерфейсе сервиса в разделе Компания. Если вы уже самостоятельно зарегистрировались в Яндекс Маршрутизации, ключ был создан автоматически и получать его в Кабинете Разработчика не нужно. После оплаты сервиса срок действия ключа продлевается.
Получение ключа в Кабинете Разработчика
-
Авторизуйтесь на Яндексе c логином, который будет использоваться для работы с API.
-
Перейдите в Кабинет Разработчика и нажмите Подключить API.
-
Выберите Маршрутизация: Планирование и Мониторинг и нажмите Продолжить.
-
Заполните анкету и нажмите Продолжить.
-
В открывшемся окне нажмите Перейти к API.
-
Откроется страница ваших ключей для API Яндекс Маршрутизации. Активация созданного ключа занимает до 15 минут, после чего его можно использовать.
Использование API-ключа
Пример запроса с авторизацией через API-ключ:
curl -H "Content-Type: application/json" -X POST -d <тело запроса> https://courier.yandex.ru/vrs/api/v1/add/mvrp?apikey=<ваш API-ключ>
В теле запроса вместо <ваш API-ключ> укажите полученный API-ключ.
Дополнительную информацию о работе с API-ключами в Кабинете Разработчика можно найти в документации сервиса.
OAuth-токен
Общие сведения
Для работы с Планированием и некоторыми функциями API Мониторинга (например, Геозоны из справочника и публичные геозоны) можно использовать OAuth-токен. Требования к OAuth-токену:
- Токен должен быть создан для пользователя, который является администратором в компании.
- Токен не должен быть отозван. Подробнее см. в разделе Время жизни токена.
Подробнее о получении токена можно прочитать в документации сервиса.
Использование OAuth-токена
Пример запроса с авторизацией через OAuth-токен:
curl -H "Content-Type: application/json" -H "Authorization: OAuth <ваш-токен>" -X POST -d <тело запроса> https://courier.yandex.ru/api/v1/vrs/add/mvrp
В заголовке Authorization: OAuth <ваш-токен> вместо <ваш-токен> укажите OAuth-токен, полученный для работы с Мониторингом.
Важно
Путь в запросе с авторизацией (с OAuth-токеном) отличается от пути, указанного в спецификации (с API-ключом).
Если при планировании используется авторизация с помощью токена, в истории решений задача будет отображаться с почтой того пользователя, на которую был оформлен токен. Использование токенов, выданных на разные почтовые адреса администраторов, поможет разделять задачи по регионам, складам или распределительным центрам. Например, для региона 1 можно использовать почту region_1@example.com, а для региона 2 — region_2@example.com.