Files
SHiNE-server/docs/API/README.md
T

2.5 KiB

API сервера SHiNE

Сервер принимает JSON-операции по WebSocket. Точный общий конверт описан в общем формате; зарегистрированные имена op — в индексе операций. Источник списка в коде: SHiNE-server/shine-server-net-protocol/src/main/java/server/logic/ws_protocol/JSON/JsonHandlerRegistry.java.

Раздел Документы
Регистрация и вход регистрация, аутентификация, сессии и pairing
Блокчейн и ключи AddBlock, ротация ключей, собственная цепочка
Каналы и профиль чтение каналов, связи, счётчики
Личные сообщения DM, push и звонки, HTTP-файлы DM
Настройки и система технические операции, параметры, настройки, уведомления
Отдельные HTTP endpoint публичные файлы, debug

Зарегистрированное имя op означает наличие обработчика, но не гарантирует доступность функции на каждом сервере: часть возможностей зависит от конфигурации, сети и состояния миграций. Сведения о текущей регистрации по email — в профильном документе. Старые планы регистрации описывают прежние этапы.

При изменении JsonHandlerRegistry обновите профильный документ и индекс. После изменения документации запустите python3 scripts/check_docs.py из корня репозитория.