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 16:15:49
}

Падзея: message

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

Спіс чатаў можна атрымаць праз метад getChats.

Дадзеныя падзеі

{
    "chat_id": 1,
    "sender": "R4CAT/P",
    "text_color": "#1E3A5F",
    "background_color": "#E6F0FA",
    "text": "Прывітанне! Я зараз у полі, дашліце кагосьці з гарбатай, тут холадна."
}

Вынік:

R4CAT/P:
Прывітанне! Я зараз у полі, дашліце кагосьці з гарбатай, тут холадна. 29.08.2025 16:15

Падзея: sun

Дасылае актуальны індэкс сонечнай актыўнасці, карысна адсочваць што б не звяртацца да API сэрвісу.

Дадзеныя падзеі

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

1 — Няма прыкметных абурэнняў.
2 — Невялікія абурэння.
3 — Слабая геамагнітная бура.
4 — Малая геамагнітная бура.
5 — Ўмераная геамагнітная бура.
6 — Моцная геамагнітная бура.
7 — Жорсткі геамагнітныя шторм.
8 — Экстрэмальны шторм.