Получение OAuth-токена

Для работы с API Мониторинга нужен OAuth-токен. Требования к OAuth-токену:

• Токен должен быть создан для пользователя, который является администратором в компании.
• Токен не должен быть отозван. Подробнее см. в разделе Время жизни токена.

Перед началом работы с API Мониторинга получите OAuth-токен:

1. При необходимости создайте аккаунт с Яндекс ID. При регистрации используйте корпоративный или любой другой электронный адрес на Яндекс Почте.

2. Авторизуйтесь на Яндексе под логином, который будет использоваться для загрузки данных.

3. Откройте страницу создания приложения в OAuth для Яндекс ID. Для доступа к дополнительным возможностям сервиса вы можете пройти верификацию с помощью вашего аккаунта на Госуслугах.

4. На шаге 1 Создание приложения:

   1. Заполните поле Название вашего сервиса. Название сервиса может быть любым. Оно появится в списке ваших приложений в сервисе OAuth для Яндекс ID. Иконку сервиса прикреплять не обязательно.
   2. В поле Почта для связи укажите адрес электронной почты.

5. На шаге 2 Платформы приложений:

   1. Выберите опцию Веб-сервисы.

   2. В появившемся поле Redirect URI вставьте адрес https://oauth.yandex.ru/verification_code.

      

6. На шаге 3 Права доступа к данным пользователей:

   1. В поле Название доступа введите courier:logistician.
   2. Выберите Загрузка данных о курьерах и заказах, выгрузка результатов (роль Логист).
   3. Нажмите кнопку Продолжить.

   

7. На шаге 4 Убедитесь, что всё указано верно нажмите внизу страницы кнопку Всё верно, создать приложение.

   Откроется страница приложения. Идентификатор приложения из поля ClientID потребуется для получения OAuth-токена.

   

8. Получите OAuth-токен. Для этого:

   1. Перейдите по ссылке. Вместо <ClientID-вашего-приложения> подставьте значение из пункта 7.

      https://oauth.yandex.ru/authorize?response_type=token&client_id=<ClientID-вашего-приложения>
      

   2. Проверьте, что сервис предлагает авторизоваться под нужным логином.

   3. Нажмите Войти как <логин>.

   4. Скопируйте последовательность символов, появившихся на экране — это и есть ваш OAuth-токен.

   5. Убедитесь, что токен работает. Для этого добавьте его в заголовок запроса:

   curl -H "Authorization: OAuth <ваш-OAuth-токен>" -X GET https://courier.yandex.ru/api/v1/test
   

   Ответом должно быть сообщение: {"message":"OK"}.

   Дополнительную информацию об OAuth можно найти в разделе Реализация OAuth в Яндексе.

Время жизни токена

Время жизни токена не ограничено.

Токен может стать недействителен в следующих случаях:

• Он был отозван. Если ваш токен отозвали, вам нужно получить новый. О причинах отзыва см. в разделе Отзыв токенов.
• Пользователь сменил пароль учетной записи, на которую был выдан токен.
• Пользователь учетной записи, на которую был выдан токен, нажал кнопку Выйти из всех сервисов Яндекса.

Решение проблем

Ошибка unauthorized_client при получении OAuth-токена

Ошибка возникает при получении OAuth-токена (пункт 8.1), если для вашего аккаунта есть ограничения. В этом случае отправьте обращение через форму. Служба поддержки примет решение о снятии ограничений и свяжется с вами.