Запрос на вход в систему

Все API запросы требуют авторизации. Токен авторизации необходимо отправить в заголовке в следующем формате:

Authorization: Bearer <integrator_token>

Токен авторизации вы получите в ответ на отправленный запрос на вход в систему. Для запроса вам необходимы учетные данные пользователя с ролью INTEGRATOR. Чтобы получить их, обратитесь в службу поддержки edna Chat Center. Далее, используйте эти данные в запросе, чтобы получить токен авторизации.

Если вы продолжите использовать токен после того, как его срок действия истечет, на все запросы будет возвращаться код 401. Чтобы получить новый токен, повторите запрос на вход в систему.

Разрешения

  ----
  Permissions:PERMIT ALL
  ----

Пример curl

$ curl 'http://localhost:8080/api/auth/login' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -d '{
  "login" : "integrator_login",
  "password" : "integrator_password",
  "locale" : "integrator_locale"
}'

Параметры запроса

ПараметрТипОписание
loginstringЛогин пользователя с ролью INTEGRATOR
passwordstringПароль пользователя с ролью INTEGRATOR
localestring (необязательно)Локализация пользователя (формат en/ru). Не используется для роли INTEGRATOR.

HTTP запрос

POST /api/auth/login HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 106
Host: localhost: 8080
{
    "login": "integrator_login",
    "password": "integrator_password",
    "locale": "integrator_locale"
}

Параметры ответа

ПараметрТипОписание
userIdlongID пользователя в edna Chat Center (не используется для роли integrator)
tokenstringТокен пользователя. Его необходимо указывать в заголовке во всех запросах от этого пользователя, которые требуют авторизации.
rolestringРоль пользователя. У пользователей разных ролей разные доступы.

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

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Authorization: Bearer Bearer <integrator_token>
Content-Type: application/json
Content-Length: 105
{
    "userId": 1,
    "login": null,
    "token": "Bearer <integrator_token>",
    "role": "OPERATOR"
}
Cледующая статья Настойка срока действия токена в edna Chat Center