--- metadata: - name: generator content: Diplodoc Platform v5.52.0 alternate: - https://yandex.kz/routing/doc/en/vrp/authorization.md - https://yandex.kz/routing/doc/kk/vrp/authorization.md - https://yandex.kz/routing/doc/ru/vrp/authorization.md - href: kk/vrp/authorization.md type: text/markdown title: Markdown version - href: llms.txt type: text/markdown title: llms.txt title: Яндекс Маршрутизация — интеграция с API — авторизация --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.kz/routing/doc/kk/llms.txt # Авторизация Авторизация в сервисе Яндекс Маршрутизации производится через Яндекс ID. Для учетной записи Яндекс Маршрутизации рекомендуется соблюдать правила [защиты аккаунта](https://yandex.ru/support/id/security.html). Для получения доступа учетная запись или Яндекс ID должны быть привязана к определенному ID компании. Учетная запись может быть привязана только к одной компании, но компания может содержать несколько учетных записей. Если ID компании уже существует, то добавить новых пользователей может администратор компании. Если [создать новую компанию](https://yandex.kz/routing/doc/kk/vrp/registration.md), то учетная запись, под которой был авторизован пользователь при создании компании, будет добавлена в качестве администратора. {% note info %} При работе с учетными записями: - Используйте для регистрации компании отдельный email, который не используется в личных целях. Это поможет сохранить доступ к компании, например, при увольнении сотрудника. Дополнительная информация в разделе [Перед регистрацией](https://yandex.kz/routing/doc/kk/vrp/registration.md). - Создавайте отдельные [учетные записи](https://yandex.kz/routing/doc/kk/delivery/interface/managers.md) для разных пользователей, чтобы сотрудники не потеряли доступ, если кто-то изменит пароль для учетной записи. {% endnote %} От того, какие функции Маршрутизации вы планируете использовать, зависит схема авторизации: - Для планирования маршрутов только через [интерфейс](https://yandex.ru/courier), достаточно ID компании и учетной записи, которая привязана к данной компании. Подробнее см. в разделе [Регистрация](https://yandex.kz/routing/doc/kk/vrp/registration.md). - Чтобы использовать API Планирования, необходим [ключ API](#api-key). - Чтобы использовать API Мониторинга и некоторые функции API Планирования (например, [Геозоны из справочника и публичные геозоны](https://yandex.kz/routing/doc/kk/vrp/geozones.md)), необходим [OAuth-токен](#oauth-token). {% note info %} Чтобы получить результат выполнения задачи на русском или английском языке, добавьте параметр `lang` со значением `ru` или `en` соответственно в конец запроса на [добавление задачи](https://yandex.kz/routing/doc/kk/vrp/add-task.md). {% endnote %} **Взаимосвязь объектов** ![](_images/account.png) ## Ключ API {#api-key} ### Общие сведения {#apikey-info} Для аутентификации в API планирования маршрутов используется ключ доступа. Его нужно передавать в запросе c HTTP-методом POST как значение параметра `apikey`. {% note info %} По ключу ведется тарификация, поэтому его должны знать только доверенные лица. {% endnote %} Получить ключ можно двумя способами: - Через [Кабинет Разработчика](https://developer.tech.yandex.ru/) — специальный портал, который позволяет генерировать ключи для API различных сервисов Яндекса. Полученный таким образом ключ будет иметь ограничения по сроку действия и некоторым другим характеристикам. После получения ключа для доступа к Рабочему месту логиста необходимо связаться с [менеджером](https://yandex.kz/routing/doc/kk/vrp/registration.md). - В веб-интерфейсе сервиса в разделе **Компания**. Если вы уже самостоятельно зарегистрировались в Яндекс Маршрутизации, ключ был создан автоматически и получать его в Кабинете Разработчика не нужно. После оплаты сервиса срок действия ключа продлевается. ### Получение ключа в Кабинете Разработчика {#get-apikey} 1. Авторизуйтесь на Яндексе c логином, который будет использоваться для работы с API. 1. Перейдите в [Кабинет Разработчика](https://developer.tech.yandex.ru/) и нажмите **Подключить API**. 1. Выберите **Маршрутизация: Планирование и Мониторинг** и нажмите **Продолжить**. 1. Заполните анкету и нажмите **Продолжить**. 1. В открывшемся окне нажмите **Перейти к API**. 1. Откроется страница ваших ключей для API Яндекс Маршрутизации. Активация созданного ключа занимает до 15 минут, после чего его можно использовать. ### Использование API-ключа {#apikey-use} Пример запроса с авторизацией через API-ключ: ```bash curl -H "Content-Type: application/json" -X POST -d <тело-запроса> https://courier.yandex.ru/vrs/api/v1/add/mvrp?apikey=<ваш-API-ключ>&lang=ru ``` В теле запроса вместо `<ваш API-ключ>` укажите полученный API-ключ. Дополнительную информацию о работе с API-ключами в Кабинете Разработчика можно найти в [документации сервиса](https://yandex.ru/dev/developer-help/doc/index-docpage/). ## OAuth-токен {#oauth-token} ### Общие сведения {#token-info} Для работы с Планированием и некоторыми функциями API Мониторинга (например, [Геозоны из справочника и публичные геозоны](https://yandex.kz/routing/doc/kk/vrp/geozones.md#geozones-methods-api)) можно использовать OAuth-токен. Требования к OAuth-токену: - Токен должен быть создан для пользователя, который является [администратором](https://yandex.kz/routing/doc/kk/delivery/interface/managers.md#user-roles) в компании. - Токен не должен быть отозван. Подробнее см. в разделе [Время жизни токена](https://yandex.kz/routing/doc/kk/delivery/quickstart/register.md#lifetime). Подробнее о получении токена можно прочитать в [документации сервиса](https://yandex.kz/routing/doc/kk/delivery/quickstart/register.md). ### Использование OAuth-токена {#token-use} Пример запроса с авторизацией через OAuth-токен: ```bash curl -H "Content-Type: application/json" -H "Authorization: OAuth <ваш-токен>" -X POST -d <тело-запроса> https://courier.yandex.ru/api/v1/vrs/add/mvrp?lang=ru ``` В заголовке `Authorization: OAuth <ваш-токен>` вместо `<ваш-токен>` укажите [OAuth-токен](https://yandex.kz/routing/doc/kk/delivery/quickstart/register.md), полученный для работы с Мониторингом. {% note warning %} Путь в запросе с авторизацией (с OAuth-токеном) отличается от пути, указанного в [спецификации](https://yandex.ru/routing/doc/ru/vrp/redoc/index.html#operation/addMVRPTask) (с API-ключом). {% endnote %} Если при планировании используется авторизация с помощью токена, в [истории решений](https://yandex.kz/routing/doc/kk/vrp/interface-history.md) задача будет отображаться с почтой того пользователя, на которую был оформлен токен. Использование токенов, выданных на разные почтовые адреса администраторов, поможет разделять задачи по регионам, складам или распределительным центрам. Например, для региона 1 можно использовать почту region_1@example.com, а для региона 2 — region_2@example.com. Написать в службу поддержки