71 lines
7.2 KiB
Markdown
71 lines
7.2 KiB
Markdown
# API для разработчиков: индекс операций
|
||
|
||
Этот файл фиксирует полный список публичных JSON/WebSocket операций, зарегистрированных в коде сервера.
|
||
|
||
Источник истины на момент актуализации:
|
||
|
||
- `shine-server-net-protocol/src/main/java/server/logic/ws_protocol/JSON/JsonHandlerRegistry.java`.
|
||
|
||
Если операция есть в `HANDLERS` и `REQUEST_TYPES`, клиент может отправлять её как `op` в общем JSON-конверте из `00_Common_API_Format.md`.
|
||
|
||
## Актуальные операции
|
||
|
||
| Операция | Раздел документации | Кратко |
|
||
| --- | --- | --- |
|
||
| `AddUser` | `01_User_Registration_API.md` | отключено (`410 / ADD_USER_DISABLED`) |
|
||
| `GetUser` | `01_User_Registration_API.md` | чтение/проверка пользователя + server-состояние его блокчейна |
|
||
| `SearchUsers` | `01_User_Registration_API.md` | поиск логинов по префиксу |
|
||
| `TestGetFreeAvatarQuota` | `14_Test_Free_Avatar_Upload_API.md` | временный тестовый просмотр остатка бесплатных загрузок аватара |
|
||
| `TestUploadFreeAvatar` | `14_Test_Free_Avatar_Upload_API.md` | временная тестовая бесплатная загрузка маленького аватара в Arweave |
|
||
| `AuthChallenge` | `02_Authentication_API.md` | challenge для создания новой сессии |
|
||
| `CreateAuthSession` | `02_Authentication_API.md` | создание новой авторизованной сессии |
|
||
| `SessionChallenge` | `02_Authentication_API.md` | challenge для входа в существующую сессию |
|
||
| `SessionLogin` | `02_Authentication_API.md` | вход в существующую сессию |
|
||
| `GetTrustedDeviceLoginSettings` | `03_Session_Management_API.md` | чтение текущего режима входа через доверенное устройство |
|
||
| `UpsertTrustedDeviceLoginSettings` | `03_Session_Management_API.md` | включение/обновление pairing-настроек доверенной сессией |
|
||
| `StartTrustedDeviceLogin` | `03_Session_Management_API.md` | создание pairing-заявки для нового устройства |
|
||
| `ListTrustedDeviceLoginRequests` | `03_Session_Management_API.md` | список активных pairing-заявок для доверенной сессии |
|
||
| `ApproveTrustedDeviceLogin` | `03_Session_Management_API.md` | подтверждение pairing-заявки доверенной сессией |
|
||
| `RejectTrustedDeviceLogin` | `03_Session_Management_API.md` | отклонение pairing-заявки доверенной сессией |
|
||
| `CancelTrustedDeviceLogin` | `03_Session_Management_API.md` | отмена pairing-заявки со стороны нового ожидающего устройства |
|
||
| `GetTrustedDeviceLoginStatus` | `03_Session_Management_API.md` | чтение статуса и результата pairing-заявки |
|
||
| `ListSessions` | `03_Session_Management_API.md` | список активных сессий |
|
||
| `CloseActiveSession` | `03_Session_Management_API.md` | закрытие активной сессии |
|
||
| `AddBlock` | `04_Add_Block_to_Blockchain_API.md` | добавление блока в блокчейн |
|
||
| `Ping` | `05_Technical_Requests_API.md` | keep-alive |
|
||
| `GetServerInfo` | `05_Technical_Requests_API.md` | публичная информация о сервере |
|
||
| `ListBlockchainHeads` | `05_Technical_Requests_API.md` | список heads всех локальных блокчейнов |
|
||
| `GetCallIceConfig` | `05_Technical_Requests_API.md` | STUN/TURN конфигурация звонков |
|
||
| `ClientErrorLog` | `05_Technical_Requests_API.md` | логирование клиентской ошибки |
|
||
| `ClientDebugLog` | `05_Technical_Requests_API.md` | клиентский debug-лог |
|
||
| `CallDeliveryReport` | `05_Technical_Requests_API.md` | диагностика доставки/установки звонков |
|
||
| `ListSubscriptionsFeed` | `06_Channels_Read_API.md` | лента каналов/подписок |
|
||
| `GetChannelMessages` | `06_Channels_Read_API.md` | сообщения канала |
|
||
| `GetMessageThread` | `06_Channels_Read_API.md` | тред сообщения |
|
||
| `GetChannelsCounters` | `06_Channels_Read_API.md` | счетчики разделов каналов |
|
||
| `ListGroupChats200` | `06_Channels_Read_API.md` | список групповых чатов типа `200` |
|
||
| `GetGroupDialog` | `06_Channels_Read_API.md` | сообщения группового чата типа `200` |
|
||
| `UpsertUserParam` | `10_User_Params_API.md` | запись параметра пользователя |
|
||
| `GetUserParam` | `10_User_Params_API.md` | чтение одного параметра пользователя |
|
||
| `ListUserParams` | `10_User_Params_API.md` | список параметров пользователя |
|
||
| `GetFriendsLists` | `11_Connections_API.md` | входящие/исходящие друзья |
|
||
| `ListContacts` | `11_Connections_API.md` | контакты текущего пользователя |
|
||
| `GetUserConnectionsGraph` | `11_Connections_API.md` | граф связей пользователя |
|
||
| `AddCloseFriend` | `11_Connections_API.md` | добавить близкого друга |
|
||
| `UpsertPushToken` | `12_Direct_Messages_Push_Calls_API.md` | регистрация WebPush-токена |
|
||
| `SendTestWebPush` | `12_Direct_Messages_Push_Calls_API.md` | тестовая push-доставка |
|
||
| `SendDirectMessage` | `12_Direct_Messages_Push_Calls_API.md` | отправка подписанного DM-пакета |
|
||
| `SendMessagePair` | `12_Direct_Messages_Push_Calls_API.md` | отправка пары входящий/исходящий DM |
|
||
| `ReceiveOutcomingMessage` | `12_Direct_Messages_Push_Calls_API.md` | алиас `SendMessagePair` |
|
||
| `ReceiveIncomingMessage` | `12_Direct_Messages_Push_Calls_API.md` | прием входящего DM-блока |
|
||
| `AckSessionDelivery` | `12_Direct_Messages_Push_Calls_API.md` | подтверждение доставки в сессию |
|
||
| `CallInviteBroadcast` | `12_Direct_Messages_Push_Calls_API.md` | broadcast приглашения к звонку |
|
||
| `CallSignalToSession` | `12_Direct_Messages_Push_Calls_API.md` | сигнал звонка в конкретную сессию |
|
||
|
||
## Важные замечания
|
||
|
||
- `ReceiveOutcomingMessage` сейчас зарегистрирован как алиас того же handler/request-класса, что и `SendMessagePair`.
|
||
- Отдельных HTTP endpoints для DM-файлов сейчас нет.
|
||
- Классы `Net_MarkChannelMessagesSeen_*` существуют в коде, но операция `MarkChannelMessagesSeen` не зарегистрирована в `JsonHandlerRegistry`, поэтому в публичный список API не входит.
|
||
- HTTP debug endpoints из `src/main/java/server/debug/` не входят в этот индекс WebSocket `op`; они описаны отдельно в `13_HTTP_Debug_API.md`.
|