first commit
This commit is contained in:
79
04-manager-api.md
Normal file
79
04-manager-api.md
Normal file
@@ -0,0 +1,79 @@
|
||||
# Manager API
|
||||
|
||||
Источник маршрутов: `internal/modules/manager/http/module.go`.
|
||||
|
||||
## Public
|
||||
|
||||
1. `POST /tenant/vk/callback/{path_token}/{tenant_id}/{group_id}`
|
||||
Callback endpoint для tenant/group.
|
||||
2. `OPTIONS /tenant/vk/callback/{path_token}/{tenant_id}/{group_id}`
|
||||
CORS/preflight.
|
||||
|
||||
## Private (`/manager/*`)
|
||||
|
||||
### Me
|
||||
|
||||
1. `GET /manager/me/profile` — профиль менеджера (`account_type`, `account_code`).
|
||||
2. `GET /manager/me/settings` — пользовательские настройки.
|
||||
3. `PUT /manager/me/settings` — обновление пользовательских настроек.
|
||||
|
||||
### Chats / Workspace
|
||||
|
||||
1. `GET /manager/chats` — список доступных чатов.
|
||||
2. `GET /manager/chats/workspace/{chat_uid}` — агрегированный workspace чата.
|
||||
3. `POST /manager/chats/workspace/{chat_uid}/events` — создать event rule.
|
||||
4. `POST /manager/chats/workspace/{chat_uid}/timers` — создать timer.
|
||||
5. `GET /manager/chats/workspace/{chat_uid}/actions` — список audit-действий.
|
||||
6. `GET /manager/chats/workspace/{chat_uid}/stats` — статистика чата.
|
||||
|
||||
### Chat addons
|
||||
|
||||
1. `GET /manager/chats/{peer_id}/addons` — список аддонов чата.
|
||||
2. `POST /manager/chats/{peer_id}/addons` — создать аддон в чате.
|
||||
3. `PATCH /manager/chats/{peer_id}/addons/{name}` — изменить аддон.
|
||||
4. `DELETE /manager/chats/{peer_id}/addons/{name}` — удалить аддон.
|
||||
5. `POST /manager/chats/{peer_id}/addons/install` — установить аддон из каталога.
|
||||
|
||||
### Chat settings
|
||||
|
||||
1. `GET /manager/chats/{peer_id}/settings` — получить базовые настройки.
|
||||
2. `PUT /manager/chats/{peer_id}/settings` — обновить базовые настройки.
|
||||
|
||||
### Groups / Callback
|
||||
|
||||
1. `GET /manager/groups` — группы пользователя.
|
||||
2. `POST /manager/groups/connect` — подключить группу.
|
||||
3. `GET /manager/groups/{group_id}/settings` — настройки группы.
|
||||
4. `PUT /manager/groups/{group_id}/settings` — обновить настройки группы.
|
||||
5. `POST /manager/groups/{group_id}/token` — сохранить token.
|
||||
6. `POST /manager/groups/{group_id}/callback/rotate-secret` — ротация секрета.
|
||||
7. `GET /manager/groups/{group_id}/callback/verify` — верификация callback.
|
||||
8. `GET /manager/groups/{group_id}/callback/events` — лог callback событий.
|
||||
9. `POST /manager/groups/{group_id}/callback/ping` — тест callback.
|
||||
10. `GET /manager/groups/{group_id}/status` — статус callback-конфигурации.
|
||||
|
||||
### Addons catalog
|
||||
|
||||
1. `GET /manager/addons/catalog` — публичный каталог approved аддонов.
|
||||
2. `GET /manager/addons/catalog/categories` — список стандартизированных категорий.
|
||||
3. `GET /manager/addons/catalog/{addon_id}/versions` — история версий каталожного аддона.
|
||||
4. `POST /manager/addons/catalog` — создать draft в каталоге.
|
||||
5. `GET /manager/addons/catalog/mine` — мои каталогные аддоны.
|
||||
6. `POST /manager/addons/catalog/{addon_id}/submit` — отправить на модерацию.
|
||||
7. `GET /manager/addons/moderation/pending` — pending для модерации.
|
||||
8. `POST /manager/addons/moderation/{addon_id}/decision` — решение модерации.
|
||||
|
||||
## Каталог аддонов: важные поля
|
||||
|
||||
1. `title`, `slug`, `addon_name`
|
||||
2. `category` (стандартизированная)
|
||||
3. `image_url`
|
||||
4. `usage_example`
|
||||
5. `gallery` (массив URL)
|
||||
6. `description`
|
||||
7. `code`
|
||||
|
||||
## Доступы
|
||||
|
||||
1. Модерация каталога (`pending`, `decision`) ограничена глобальным уровнем аккаунта `account_type >= moderator`.
|
||||
2. Дополнительно поддерживается legacy-список moderator VK IDs.
|
||||
Reference in New Issue
Block a user