Аутентификация
По умолчанию все данные на платформе являются конфиденциальными. Каждому пользователю должна быть выдана роль для доступа к определенным данным, после этого вы можете передать токен доступа в API для доступа к частным данным.
Токен доступа
Платформа поддерживает два типа токенов, которые можно использовать для аутентификации.
Временный токен (JWT) - возвращается из метода Логин. Эти токены имеют относительно короткий срок действия и, таким образом, являются наиболее безопасным вариантом для использования. Токены возвращаются с refresh_token, которые можно использовать для получения нового доступа через метод Обновление.
Статический токен - может быть установлен для каждого пользователя платформы и никогда не истекают. Они менее безопасны, но очень полезны для межсерверной связи. Они сохраняются в виде системного текстового значения внутри записи пользователя.
Получив токен доступа, вы можете передавать его в API двумя способами: с помощью access_token внутри параметра запроса или в заголовке Authorization
Параметр запроса
?access_token=token
Заголовок авторизации
Authorization: Bearer token
Логин
Возвращает временный токен доступа и токен обновления.
Тело запроса
| название | тип | описание |
|---|---|---|
| string | Валидное значение почты | |
| password | string | Пароль |
POST /auth/login
{
"email": "admin@example.com",
"password": "tms_password"
}
2
3
4
Параметры ответа
| название | тип | описание |
|---|---|---|
| access_token | string | Временный токен доступа |
| expires | int | Время истечения токена. Время в миллисекундах (unix epoch) |
| refresh_token | string | Токен, который можно использовать для получения нового токена методом Обновление |
Предупреждение
Время действия токена настраивается в системе и может измениться
По умолчанию действие временного токена 15 минут с момента формирования
Обновление
Тело запроса
| название | тип | описание |
|---|---|---|
| refresh_token | string | Токен обновления |
POST /auth/refresh
{
"refresh_token": "jsdf...7ksdh"
}
2
3
Параметры ответа
| название | тип | описание |
|---|---|---|
| access_token | string | Временный токен доступа |
| expires | int | Время истечения токена. Время в миллисекундах (unix epoch) |
| refresh_token | string | Токен, который можно использовать для получения нового токена методом Обновление |
Важно
Токен обновления так же имеет время жизни, но значительно выше, чем у временного токена
То есть в определенных случаях данный метод может вернуть ошибку. По умолчанию время жизни токена обновления 7 дней