October 7, 2020

Набросок документации

Суть: на сайте платформы пользователю предлагается авторизироваться в одном из ботов, дается ссылка на бота + код авторизации

После этого появляется возможность отправлять пользователю сообщения напрямую в бота через выданный ему айди (который где-то на стороне платформы потребуется записать к пользователю) или же через присвоенную ему категорию

Здесь не представлен метод общения с преподавателем, но он будет реализован через активацию пользователем по нажатию кнопки режима общения и дальше мы начнем присылать напрямую на платформу сообщения пользователя, на метод заранее для нас подготовленный

GET /api/user/createToken
Создает уникальный ключ для авторизации пользователя
Возвращает GUID + ID пользователя

POST /api/user/isAuthed
Проверяет авторизировался ли пользователь
- userID - наш ID пользоватя

GET /api/category/list
Список категории пользователей

POST /api/category/create
application/json
Создает категорию пользователей
- code - код категории (в дальнейшем он используется в других методах, которые получают поле category)

POST /api/user/setgroup
application/json
- userID -НАШ id нужного пользователя
- category - новая категория пользователя, если надо поменять

POST /api/mailing/create
multipart/form-data
- text - текст рассылки
- category - категория, которой отправляем рассылку
- userID - НАШ id нужного пользователя, если конкретному надо
- socialType - строка VK или TG, если надо только в одно место отправить, по умолчанию и туда и туда рассылка будет
+ файлы с любым ключем, можно просто file1, file2 и т.д., не более 10 штук