Получение OAuth-токена
Для работы с API Мониторинга нужен OAuth-токен. Требования к OAuth-токену:
- Токен должен быть создан для пользователя, который является администратором в компании.
- Токен не должен быть отозван. Подробнее см. в разделе Время жизни токена.
Перед началом работы с API Мониторинга получите OAuth-токен:
|
Получение OAuth-токена. Краткая инструкция Посмотреть видео |
-
При необходимости создайте аккаунт с Яндекс ID. При регистрации используйте корпоративный или любой другой электронный адрес на Яндекс Почте.
-
Авторизуйтесь на Яндексе под логином, который будет использоваться для загрузки данных.
-
Откройте страницу создания приложения в OAuth для Яндекс ID.
-
В разделе Общие данные заполните поле Название вашего сервиса. Название сервиса может быть любым. Оно появится в списке ваших приложений в сервисе OAuth для Яндекс ID.
Иконку сервиса прикреплять не обязательно.
-
В разделе Платформы приложения:
-
Выберите опцию Веб-сервисы.
-
Поставьте курсор в появившемся поле Redirect URI и вставьте адрес
https://oauth.yandex.ru/verification_code
или во всплывающей подсказке нажмите Подставить URL для отладки.
-
-
В разделе Доступ к данным введите
courier:logistician
и выберите Загрузка данных о курьерах и заказах, выгрузка результатов (роль Логист). -
В разделе Почта для связи укажите адрес электронной почты.
-
Внизу страницы нажмите кнопку Создать приложение.
Откроется страница приложения. Идентификатор приложения из поля ClientID потребуется для получения OAuth-токена.
-
Получите OAuth-токен. Для этого:
-
Перейдите по ссылке. Вместо
<ClientID-вашего-приложения>
подставьте значение из пункта 8.https://oauth.yandex.ru/authorize?response_type=token&client_id=<ClientID-вашего-приложения>
-
Проверьте, что сервис предлагает авторизоваться под нужным логином.
-
Нажмите Войти как <логин>.
-
Скопируйте последовательность символов, появившихся на экране — это и есть ваш OAuth-токен.
-
Убедитесь, что токен работает. Для этого добавьте его в заголовок запроса:
curl -H "Authorization: OAuth <ваш-OAuth-токен>" -X GET https://courier.yandex.ru/api/v1/test
Ответом должно быть сообщение:
{"message":"OK"}
.Дополнительную информацию об OAuth можно найти в разделе Реализация OAuth в Яндексе.
-
Время жизни токена
Время жизни токена не ограничено.
Токен может стать недействителен в следующих случаях:
- Он был отозван. Если ваш токен отозвали, вам нужно получить новый. О причинах отзыва см. в разделе Отзыв токенов.
- Пользователь сменил пароль учетной записи, на которую был выдан токен.
- Пользователь учетной записи, на которую был выдан токен, нажал кнопку Выйти из всех сервисов Яндекса.
Решение проблем
Ошибка unauthorized_client при получении OAuth-токена
Ошибка возникает при получении OAuth-токена (пункт 8.1), если для вашего аккаунта есть ограничения. В этом случае отправьте обращение через форму. Служба поддержки примет решение о снятии ограничений и свяжется с вами.
Примечание
Перед заполнением формы убедитесь, что вы авторизованы под аккаунтом, для которого возникли ограничения, иначе форма не откроется.