Авторизация

Облачный Pyrus

Безоблачный Pyrus

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

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

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

Подсказка: если у вас зарегистрировано несколько учетных записей на одну электронную почту, то для получения токена необходимо добавить параметр "person_id", где "person_id" равен ID сотрудника.

{
   "login": "ВАША ПОЧТА",

   "security_key": "СЕКРЕТНЫЙ КЛЮЧ",

   "person_id": 16900
}

POST /auth

https://api.pyrus.com/v4/auth

Тело запроса

{
    "login": "bill.smith@somedomain.edu",
    "security_key": "czSHwEAthJKMshQ*****"
}

Тело ответа

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

curl

curl -X POST \
  https://api.pyrus.com/v4/auth/ \
  -H 'Content-Type: application/json'
  -d '{
    "login": "<YOUR_LOGIN>",
    "security_key": "<YOUR_SECURITY_KEY>"
}'

Параметры

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

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

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

Authorization: Bearer gAAAAA15vmSeoj*******

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

Отзыв токена

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

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