Авторизация

Авторизация в сервисе Яндекс Маршрутизация производится через Яндекс ID. Для учетной записи Яндекс Маршрутизации рекомендуется соблюдать правила защиты аккаунта.

Для получения доступа учетная запись или Яндекс ID должны быть привязаны к определенному ID компании. Создание компании и ее привязка к учетной записи выполняются сотрудником сервиса Яндекс Маршрутизация.

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

При работе с учетными записями:

• Используйте для регистрации компании отдельную электронную почту, которая не используется в личных целях. Это поможет сохранить доступ к компании, например, при увольнении сотрудника. Дополнительную информацию см. в разделе Перед регистрацией документа Планирование маршрутов.

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

Авторизационный токен

Чтобы использовать API Экспресс-доставки, необходим OAuth-токен. Требования к токену:

• Обязателен для всех запросов к API Экспресс-доставки. Если токен оформлен неверно или отсутствует, запрос будет отклонен с ошибкой авторизации.
• Создается для учетной записи администратора компании.
• Может использоваться для всех запросов в рамках одной компании.

При работе с OAuth-токеном учитывайте ситуации, когда может произойти Отзыв токена.

Токен идемпотентности

Токен идемпотентности — это уникальный идентификатор (строка, число, UUID и т. п.), который генерируется на стороне клиента и отправляется вместе с запросом к сервису Маршрутизации. Его главная цель — позволить сервису распознать повторяющиеся запросы и обработать их корректно.

Сервис использует этот токен как ключ, чтобы запомнить, что операция с таким идентификатором уже была выполнена. В этом случае сервис возвращает клиенту тот же самый ответ и не выполняет никакие повторные действия.

Преимущества использования токена:

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

Требования к токену идемпотентности:

• уникальность — он должен быть непредсказуемым и не повторяться для разных операций;
• срок хранения должен быть ограничен, например 24 часа;
• семантика операции — токен гарантирует однократное выполнение, но не отменяет уже совершенных изменений;
• идентификация операции — токен связывает конкретный запрос с его результатом.