Network

Данная документация описывает работу с сервисом передачи данных в режиме реального времени. Прочтите внимательно данную документацию, для понимания работы с нашей сетью.

Первое подключение:

Для начала требуется определить IP адрес сервера и порт, поскольку серверов может быть более одного и какие-то сервера могут отключаться и подключаться нами, воспользуйтесь API v2 методом getListSpotServers. Данный метод вернёт список IP адресов и порты серверов, для подключения.

Обратите внимание, что метод getListSpotServers возвращает количество подключенных клиентов, рекомендуем Вам подключатся к серверу у которого наименьшее количество клиентов. Такой подход распределит нагрузку равномерно.

Подключиться можете с помощью TCP Logger стороннего софта, либо выполнив команду в терминале:

Terminal

telnt {ip} {port}

После подключения, Вы начнёте получать сообщения в json формате, далее мы будем говорить об этих сообщениях, как о событиях. Ниже приведен пример событий spot, какие события есть и как их обрабатывать читайте далее.

События:

На данный момент существует только 3 события, это: spot, message, sun. Все события, которые транслируются на серверах из метода getListSpotServers, являются идентичными. Это сделано для того, чтобы гарантировать доставку сообщений, спотов и любых других данных всем пользователям системы. Независимо от того, к какому конкретному серверу подключён пользователь, он получит полный и одинаковый набор событий. Таким образом обеспечивается единообразие данных и синхронность работы всех клиентов в распределённой среде.

Общая структура JSON сообщения

{
    "event": "name_event", // ENUM могут быть значения: spot, message, sun
    "data": {...}, // Данне события, читайте описание событий.
    "event_at": "Y-m-d H:i:s" // Дата и время события: 2025-08-29 19:25:16
}

Событие: message

Данное событие информирует об отправке сообщения в чате. Для этого используется API-запрос к методу sendMessage. Подробности о работе с отправкой сообщений смотрите в документации API v2.

Список чатов можно получить через метод getChats.

Данные события

{
    "chat_id": 1,
    "sender": "R4CAT/P",
    "text_color": "#1E3A5F",
    "background_color": "#E6F0FA",
    "text": "Привет! Я сейчас в поле, пришлите кого-то с чаем, тут холодно."
}

Результат:

R4CAT/P:
Привет! Я сейчас в поле, пришлите кого-то с чаем, тут холодно. 29.08.2025 19:25

Событие: sun

Присылает актуальный индекс солнечной активности, полезно отслеживать что бы не обращаться к API сервиса.

Данные события

{
    "value": 4 // Малая геомагнитная буря.
}

1 — Нет заметных возмущений.
2 — Небольшие возмущения.
3 — Слабая геомагнитная буря.
4 — Малая геомагнитная буря.
5 — Умеренная геомагнитная буря.
6 — Сильная геомагнитная буря.
7 — Жесткий геомагнитный шторм.
8 — Экстремальный шторм.