Skip to content

Метод логина

Метод /api/v1/login предназначен для аутентификации партнёра и получения JWT-токена, который используется для доступа к защищённым методам API.

URL и Метод

URL: 

POST https://verify.promotivation.ru/api/v1/login/

HTTP метод:
POST

Заголовки запроса

  • Content-Type: application/json

Тело запроса

Тело запроса должно быть представлено в формате JSON и содержать следующие параметры:

{
  "login": "your_partner_login",
  "password": "your_api_password"
}

Параметры

Параметр Тип Описание Обязательный
login string Уникальное имя партнёра, выдается при заключении договора. Да
password string Уникальный API пароль партнёра, выдается при заключении договора. Да

Ответ

При успешной аутентификации сервер возвращает JWT-токен, который необходимо использовать в заголовке Authorization для всех последующих запросов.

Пример успешного ответа

{
  "access_token": "1jijdsaohdiadibbcsanco……..",
  "token_type": "bearer",
  "expires_in": 3600
}

Коды ответа сервера

  • 200 OK
    Токен аутентификации успешно получен.

  • 401 Unauthenticated
    Неверный логин или пароль.

  • 403 Forbidden
    Доступ запрещён.

Примечания

  • Полученный access_token необходимо передавать в заголовке Authorization в формате: ~~~shell Authorization: Bearer {access_token} ~~~
  • Время жизни токена указано в поле expires_in (в секундах). После истечения этого времени необходимо выполнить повторную аутентификацию или использовать метод обновления токена.