Skip to main content

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

Authorization
string
required
API токен сервисного пользователя в формате Bearer. Получите токен в панели администратора школы. Формат: Bearer YOUR_TOKEN.
Seller-Id
string
required
Уникальный идентификатор продавца в системе. Используется для разграничения доступа между разными продавцами.
School-Id
string
required
Уникальный идентификатор школы в системе. Определяет контекст выполнения операции.

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

userId
integer
required
ID пользователя в системе Exode. Целое число.
forceCreate
boolean
default:"false"
Принудительное создание новой сессии. Если true — всегда создается новая сессия, даже если у пользователя уже есть активная. Если false или не указан — возвращается существующая активная сессия (или создается новая, если существующей нет).
Метод создает новую сессию для пользователя или возвращает существующую активную сессию. Токен сессии используется для аутентификации пользователя в системе. Флаг isCreated в ответе указывает, была ли создана новая сессия или возвращена существующая.
Пользователи с правами администратора или менеджера школы не могут создавать сессии через этот метод.
curl --location --request POST 'https://api.exode.biz/saas/v2/user/session/auth-token' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data-raw '{
    "userId": 123,
    "forceCreate": false
  }'
{
  "success": true,
  "code": 201,
  "payload": {
    "isCreated": true,
    "session": {
      "id": 3537,
      "createdAt": "2025-07-29T10:26:19.037Z",
      "updatedAt": "2025-07-29T10:26:19.917Z",
      "deletedAt": null,
      "uuid": "a65aa524-f822-4f89-9608-4fb5d4425877",
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
      "alive": true,
      "isOnline": false,
      "location": {},
      "launcher": "Web",
      "lastActivityAt": "2025-07-29T10:26:19.037Z",
      "timezone": null,
      "expireAt": "2027-07-29T10:26:18.823Z"
    }
  }
}

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

session
object
required
Объект сессии пользователя.
isCreated
boolean
required
Флаг, указывающий была ли создана новая сессия. true — сессия была создана, false — возвращена существующая активная сессия.

Требования к правам доступа

Для создания токена сессии пользователя требуется право на управление пользователями школы.
Сервисный пользователь должен быть аутентифицирован по токену и иметь соответствующие права доступа к указанной школе.

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

Токен сессии имеет ограниченный срок действия (обычно 2 года). После истечения срока действия пользователю необходимо создать новую сессию.
Автоматическая авторизация пользователя:Для автоматического входа пользователя в приложение используйте GET параметр ___uat в URL:
https://my-school.com/education?___uat=TOKEN_FROM_SESSION
Где TOKEN_FROM_SESSION — значение поля token из ответа этого API метода.
Пользователь будет автоматически авторизован при переходе по такой ссылке.