Конечная точка для нашего WebSocket API — wss://api.sati.ac/ws
Все сообщения должны быть JSONом следующей структуры:
Все сообщения должны быть JSONом следующей структуры:
Name | Type | Required | Description |
id | number | Yes | Уникальный айди сообщения на подключение |
type | string | Yes | Тип сообщения |
data | object | Yes | Содержание сообщения |
to | number | No | Айди сообщения, ответом на которое является это |
Типы сообщений отправляемые клиентом
auth — Авторизация
Name | Type | Required | Description |
token | string | Yes | API токен |
call — Вызов метода
Name | Type | Required | Description |
method | string | Yes | Название метода |
data | object | Yes | Параметры для этого метода, см. методы |
Типы сообщений отправляемые сервером
auth — Результат авторизации
Name | Type | Required | Description |
success | boolean | Yes | Успешна ли авторизация |
call — Результат вызова метода
Name | Type | Required | Description |
success | boolean | Yes | Успешен ли вызов |
data | object | Yes | Результат, при success = false — ошибка |
event — Событие
Name | Type | Required | Description |
type | string | Yes | Название события |
data | object | Yes | Данные |