Вход через форум
Добавьте на свой сайт кнопку «Войти через форум». Человек подтверждает вход на странице форума, а сайт получает его имя, фото, юзернейм, ID и почту Google. Пароль и переписка сайту не передаются.
1. Компания и проект
В форуме откройте Настройки → Для разработчиков → Вход через форум. Для этого к аккаунту должна быть привязана Google-почта (Настройки → «Аккаунт и вход»).
- Создайте компанию: название, логотип, адрес сайта
https://example.com, ссылки на политику конфиденциальности и условия использования. Для компании автоматически создаётся публичный канал. - Подтвердите сайт: добавьте в
<head>главной страницы тег, который покажет форум, и нажмите «Проверить сайт»:<meta name="forum-site-verification" content="fv_..."> - Создайте проект: название, логотип, сайт и
redirect_uri(оба на домене подтверждённого сайта компании, только https), почта поддержки, по желанию канал новостей. Заявку проверяют модераторы. - После принятия нажмите «Секрет» у проекта: вы получите
client_idиclient_secret. Секрет показывается один раз, при перевыпуске старый перестаёт работать.
2. Отправьте человека на форум
https://rid3-forum.pages.dev/home/#/oauth?client_id=CLIENT_ID&redirect_uri=REDIRECT_URI&state=RANDOM
redirect_uri должен в точности совпадать с зарегистрированным. state придумайте сами (случайная строка, сохраните её в сессии) и сверьте при возврате, это защита от подделки запроса.
3. Человек вернётся к вам
REDIRECT_URI?code=ONE_TIME_CODE&state=RANDOM
Если человек нажал «Отмена»: ?error=access_denied&state=…. Если не привязан Google или аккаунт заморожен: ?error=5001&error_name=ERR%3A…&state=… (коды из таблицы ниже).
4. Обменяйте code на токен (с вашего сервера)
POST https://rid3-forum.pages.dev/api/oauth/token
Content-Type: application/json
{"client_id":"fp_...","client_secret":"fs_...","code":"ONE_TIME_CODE","redirect_uri":"REDIRECT_URI"}
→ 200 {"access_token":"ft_...","token_type":"Bearer","expires_in":3600}
Код одноразовый и живёт 5 минут. Поддерживается и форма application/x-www-form-urlencoded. Никогда не отправляйте client_secret в браузер.
5. Получите профиль
GET https://rid3-forum.pages.dev/api/oauth/userinfo
Authorization: Bearer ft_...
→ 200 {"id":"2108785060","username":"@hoshi_sky","name":"Имя","avatar":"https://…/api/avatar/…","email":"user@gmail.com"}
id постоянный, по нему узнавайте человека (имя и юзернейм можно менять; имена могут повторяться, юзернеймы нет). Если у человека нет юзернейма, вместо него приходит #ID. avatar равен null, если фото нет.
Публичная информация о проекте для вашей страницы: GET /api/oauth/info?client_id=…
Боты
Бот это обычный сервер на вашей стороне. Форум отправляет на него события, а сообщения от имени бота вы шлёте через API. В личном чате с ботом люди пишут ему сами или находят его по @юзернейму в поиске.
События на ваш сервер
Тип запроса (JSON, форма или GET) выбирается при создании бота. Поля:
| Поле | Описание |
|---|---|
event | message (сообщение боту или упоминание) или callback (нажата кнопка) |
bot_id, message_id, time | номер бота, номер сообщения, время (мс) |
text | текст сообщения (для callback то же, что data) |
user_id, user_name, user_num | кто написал или нажал |
data | только для callback: значение нажатой кнопки |
chat | dm, если это личный чат с ботом |
Подпись
В заголовке x-bot-signature лежит HMAC-SHA256 (hex) от тела запроса. Ключ: SHA-256 вашего токена в hex.
const key = sha256hex(BOT_TOKEN);
const sig = hmacSha256Hex(key, rawBody);
if (sig !== req.headers['x-bot-signature']) reject();
Ответ на событие
Ответьте текстом или JSON {"text":"…","buttons":[[…]]}. Текст уйдёт человеку (в личке) или в чат. Для callback ответ изменяет то же сообщение, а не создаёт новое.
Отправка сообщений
POST /api/bot/send
Authorization: Bot BOT_TOKEN
{"user_id":"…" | "user_num":2108785060,"text":"Привет","buttons":[[{"text":"Да","data":"yes"}]]}
→ {"ok":true,"id":123}
POST /api/bot/edit
{"message_id":123,"kind":"d","text":"Новый текст","buttons":null} // kind: "d" — личка, "m" — общий чат
Без user_id/user_num сообщение уходит в общий чат. Писать можно тем, кто не заблокировал бота и не остановил его. Исправить можно только своё сообщение.
Коды ошибок
Все ошибки API для разработчиков приходят в таком виде (HTTP-статус соответствует таблице):
{"ok":false,"code":"8010","error":"ERR:…","message":"…","http":401,"detail":"уточнение (необязательно)"}
Актуальный список в текстовом виде: /api/errors.
| Код | Имя | Описание | HTTP |
|---|---|---|---|
0000 | ERR:UNKNOWN_ERROR | Неизвестная или необработанная ошибка системы. | 500 |
0001 | ERR:MULTIPLE_ERRORS_OCCURRED | При обработке запроса произошло несколько ошибок. | 400 |
0002 | ERR:BATCH_PARTIAL_FAILURE | Часть операций в пакетном запросе завершилась с ошибкой. | 207 |
0003 | ERR:SYSTEM_MAINTENANCE | Система временно недоступна из-за проведения технического обслуживания. | 503 |
0004 | ERR:REQUEST_CANCELLED | Выполнение операции было отменено пользователем или таймаутом. | 499 |
0005 | ERR:DEPRECATED_API_VERSION | Используемая версия API устарела и больше не поддерживается. | 410 |
5000 | ERR:INTERNAL_API_ERROR | Внутренняя необработанная ошибка API-сервера. | 500 |
5001 | ERR:THE_SERVER_REJECTED_THE_SESSION | Сервер отклонил текущую сессию пользователя. | 403 |
5002 | ERR:SERVER_ERROR_ACCESS_DENIED | Сервер отказал в доступе к ресурсу из-за внутренних правил. | 403 |
5003 | ERR:SERVICE_UNAVAILABLE | Сервер или микросервис временно перегружен. | 503 |
5004 | ERR:MANY_REQUESTS | Превышен лимит частоты отправки запросов (Rate Limit). | 429 |
5005 | ERR:DATABASE_TIMEOUT | Превышено время ожидания ответа от базы данных. | 504 |
5006 | ERR:GATEWAY_BAD_RESPONSE | Получен некорректный ответ от внутреннего микросервиса. | 502 |
5007 | ERR:THIRD_PARTY_SERVICE_FAILURE | Сбой при вызове стороннего внешнего сервиса. | 502 |
5008 | ERR:FEATURE_DISABLED | Запрашиваемый функционал отключен конфигурацией сервера. | 501 |
5009 | ERR:DATABASE_CONNECTION_FAILED | Ошибка подключения к серверу баз данных. | 500 |
6000 | ERR:FRONTEND_RENDER_ERROR | Ошибка рендеринга компонента UI в JavaScript Runtime. | 0 |
6001 | ERR:CLIENT_STATE_CORRUPTED | Повреждение локального состояния приложения (Store/LocalStorage). | 0 |
6002 | ERR:STORAGE_QUOTA_EXCEEDED | Превышен лимит локального хранилища браузера (LocalStorage/IndexedDB). | 0 |
6103 | ERR:CONNECTION_FAILURE | Не удалось установить соединение с сервером на стороне клиента. | 0 |
6104 | ERR:UNSUPPORTED_BROWSER | Браузер не поддерживает требуемые Web API. | 0 |
6105 | ERR:ASSET_LOAD_FAILED | Сбой при загрузке статического бандла (JS/CSS/Font). | 0 |
6106 | ERR:SCRIPT_EXECUTION_TIMEOUT | Превышено время выполнения клиентского скрипта. | 0 |
7000 | ERR:NETWORK_OFFLINE | У пользователя отсутствует подключение к сети Интернет. | 0 |
7001 | ERR:CONNECTION_REFUSED | Сервер отклонил сетевое соединение на транспортном уровне. | 0 |
7002 | ERR:CONNECTION_TIMED_OUT | Превышено время ожидания установления TCP/IP соединения. | 504 |
7003 | ERR:DNS_LOOKUP_FAILED | Не удалось разрешить доменное имя сервера через DNS. | 0 |
7004 | ERR:DNS_NAME_NOT_RESOLVED | Доменное имя не существует или не найдено в DNS (NXDOMAIN). | 0 |
7005 | ERR:DNS_SERVER_FAILED | DNS-сервер вернул ошибку обработки запроса (SERVFAIL). | 0 |
7006 | ERR:DNS_TIMED_OUT | Превышено время ожидания ответа от DNS-сервера. | 0 |
7007 | ERR:DNS_PROBE_FINISHED_NXDOMAIN | Проверка DNS завершена: имя хоста не найдено. | 0 |
7008 | ERR:DNS_REFUSED | DNS-сервер отказался выполнять запрос. | 0 |
7009 | ERR:DNSSEC_VALIDATION_FAILED | Ошибка проверки подлинности цифровой подписи DNSSEC. | 0 |
7010 | ERR:SSL_HANDSHAKE_FAILED | Сбой при установке защищенного TLS/SSL соединения. | 0 |
7011 | ERR:CORS_POLICY_VIOLATION | Запрос заблокирован политикой безопасности браузера (CORS). | 0 |
7012 | ERR:WEBSOCKET_DISCONNECTED | Постоянное WebSocket-соединение разорвано. | 0 |
7013 | ERR:PROXY_AUTHENTICATION_REQUIRED | Промежуточный прокси-сервер требует авторизации. | 407 |
8000 | ERR:BAD_REQUEST | Некорректный синтаксис запроса или некорректный JSON. | 400 |
8001 | ERR:INVALID_PAYLOAD_FORMAT | Переданные данные не соответствуют ожидаемой JSON-схеме. | 422 |
8002 | ERR:MISSING_REQUIRED_FIELD | В запросе отсутствует обязательное поле. | 422 |
8003 | ERR:INVALID_PARAMETER_VALUE | Переданное значение параметра не прошло валидацию. | 422 |
8004 | ERR:RESOURCE_NOT_FOUND | Запрашиваемый ресурс не найден. | 404 |
8005 | ERR:PAYLOAD_TOO_LARGE | Размер передаваемых данных превышает допустимый лимит. | 413 |
8006 | ERR:UNSUPPORTED_MEDIA_TYPE | Заголовок Content-Type не поддерживается эндпоинтом. | 415 |
8007 | ERR:DUPLICATE_RESOURCE | Запись с такими уникальными идентификаторами уже существует. | 409 |
8008 | ERR:UNAUTHORIZED | Для выполнения запроса требуется аутентификация. | 401 |
8009 | ERR:TOKEN_EXPIRED | Срок действия токена доступа (Access Token) истек. | 401 |
8010 | ERR:INVALID_TOKEN | Передан недействительный или поврежденный токен. | 401 |
8011 | ERR:FORBIDDEN_ACCESS | Учетная запись не имеет прав на выполнение этого действия. | 403 |
8012 | ERR:ACCOUNT_LOCKED | Аккаунт заблокирован из-за нарушений или подозрительной активности. | 403 |