Авторизация. Pyrus Help
api:authorization

Авторизация

Чтобы начать работать с API, выполните следующие действия:

  1. Создайте учетную запись бота в Pyrus. Боты — это технические пользователи, которые не могут работать через веб- или мобильное приложение. Подробную инструкцию по создаю ботов вы можете найти в справке.
  2. Зайдите в профиль бота и скопируйте ключ доступа к API — security_key. Если у пользователя еще нет ключа доступа, нажмите кнопку Получить ключ.
  3. Выполните запрос авторизации auth. Он возвращает access_token, который нужно передавать при каждом последующем запросе.

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

GET /auth

https://api.pyrus.com/v4/auth
    ?login=bill.smith@somedomain.edu
    &security_key=czSHwEAthJKMshQ*****
Показать ответ

{
    "access_token": "gAAAAA15vmSeoj*****"
}

Параметры

login Логин.
security_key Секретный ключ, полученный на шаге 2.

Использование токена

Полученный токен необходимо указывать в HTTP заголовке Authorization при каждом запросе к API:

Authorization: Bearer gAAAAA15vmSeoj*******

Срок действия токена ограничен, поэтому ваше приложение должно уметь повторно проходить процедуру авторизации в случае отзыва токена.

Отзыв токена

Токен авторизации может быть отозван в следующих случаях:

  • Срок жизни токена истек.
  • Превышено максимальное количество токенов для пользователя. При превышении лимита получение каждого нового токена приводит к отзыву самого старого активного токена.
  • Пользователь сменил ключ авторизации security_key в своем профиле. В таком случае все выданные токены будут отозваны.
  • Пользователь изменил пароль.
  • Учетная запись пользователя была заблокирована.

Была ли эта статья полезной?

Да, спасибо! Нет, остался вопрос