Методы API доступны только для внутренних интеграций.

Логин

URL метода API
https://litepilot-api.r-keeper.ru/auth/login

Формат запроса
Тело запроса:

{
  "data": {
    "serviceName": "string",
    "password": "string"
  }
}

Описание параметров

ПараметрТипОбязательностьОписание
serviceNamestringдаСтроковый идентификатор внешней системы.
passwordstringдаПароль внешней системы.


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

clientnameИмя клиента, данные которого запрашиваются.


Формат ответа

{
  "result": {
    "refreshToken": "string",
    "accessToken": "string",
    "accessTokenExpiresAt": "2020-07-14T13:54:46.869Z"
  },
  "error": {
    "fields": {},
    "code": "401",
    "msg": "Неверный логин или пароль аутентификации внешнего сервиса"
  }
}

Описание параметров

ПараметрТипОбязательностьОписание
refreshTokenstringдаТокен для получения нового токена доступа в случае истекшего времени жизни токена доступа.
accessTokenstringдаТокен доступа.
accessTokenExpiresAtstringдаДата/время истечения срока жизни токена доступа.
fieldsobjectнетИнформация об ошибке в случае её возникновения.
codestringдаКод ошибки.
msgstringдаОписание ошибки.

Обновление токена доступа

URL метода API
https://litepilot-api.r-keeper.ru/auth/jwt/refresh

Формат запроса
Тело запроса:

{
  "data": {
    "serviceName": "string",
    "refreshToken": "string"
  }
}

Описание параметров

ПараметрТипОбязательностьОписание
serviceNamestringдаСтроковый идентификатор внешней системы.
refreshTokenstringдаТокен для получения нового токена доступа в случае истекшего времени жизни токена доступа.


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

clientnameИмя клиента, данные которого запрашиваются.


Формат ответа

{
  "result": {
    "refreshToken": "string",
    "accessToken": "string",
    "accessTokenExpiresAt": "2020-07-14T13:54:46.869Z"
  },
  "error": {
    "fields": {},
    "code": "401",
    "msg": "Неверный логин или пароль аутентификации внешнего сервиса"
  }
}

Описание параметров

ПараметрТипОбязательностьОписание
refreshTokenstringдаТокен для получения нового токена доступа в случае истекшего времени жизни токена доступа.
accessTokenstringдаТокен доступа.
accessTokenExpiresAtstringдаДата/время истечения срока жизни токена доступа.
fieldsobjectнетИнформация об ошибке в случае её возникновения.
codestringдаКод ошибки.
msgstringдаОписание ошибки.