Справочник API

Авторизация и токены

Вход на устройство и токен. После входа token и c-id должны принадлежать одному сеансу.

Процесс входа на устройство

Клиент
https://<host>:<port>/init
Сервер

POST /init

HTTP request

c-id: clientId · body: empty

Наведите указатель на поле или коснитесь его
1 / 7

sessionKey = Base64Decode(token). Обе стороны выводят ключ при входе; не отправлять как Bearer. logout или revokeSession отзывает сеанс; смена пароля — нет.

Создать в приложении устройства: Подключения → API-токены. Копировать clientId и token вместе. Удаление отзывает токен. Bearer отправлять только по HTTPS.

Шифрование HTTP-тела не защищает загруженный веб-код. При первом входе нужна доверенная идентичность сервера; в браузере используйте доверенный HTTPS.

Если открыто слишком много неаутентифицированных соединений, сервер до перехода на WebSocket возвращает HTTP 429 с пустым телом. Повторите попытку позже.

WebSocket /auth · AuthErrorCode · Ошибки

Первый кадр: 10 с. Затем 60 с на handshake. Вход и подтверждение: всего 300 с.

INVALID_LOGIN_REQUEST
Проверьте запрос на вход и начните новое рукопожатие.
PASSWORD_SETUP_REQUIRED
Сначала задайте пароль для входа на устройстве.
INVALID_PASSWORD
Проверьте пароль и повторите попытку.
PEER_IDENTITY_CHANGED
Перед продолжением проверьте подлинность устройства.
REMOTE_ACCESS_DISABLED
Включите удалённый доступ на устройстве.
REJECTED
Владелец устройства отклонил вход.
TIMEOUT
Создайте новый запрос на вход.
TOO_MANY_LOGIN_ATTEMPTS
Подождите перед повторной попыткой.

Операции

http

API-токен Bearer

Используйте отдельный API Token для отправки JSON через HTTPS без шифрования тела.

bash
curl --request POST \
  --url 'https://<device-host>:<https-port>/graphql' \
  --header 'c-id: <client-id>' \
  --header 'Authorization: Bearer <api-token>' \
  --header 'Content-Type: application/json' \
  --data '{"query":"{ app { deviceName capabilities access } }"}'
mutation

logout

Отзывает текущий аутентифицированный сеанс вызывающего клиента.

graphql
mutation logout {
  logout
}