API Portal

Разработчикам

Создавайте и управляйте своими ботами, приложениями и интеграциями

Начало работы

Vibe Bot API позволяет легко подключать внешнюю автоматизацию, игры и сервисы. Поддерживается слой нативной совместимости со стандартом Telegram Bot API.

Аутентификация

Каждый запрос к API должен содержать секретный токен вашего бота. Вы можете передавать его в URL пути по стандартной схеме:

https://dev.v-vibe.ru/api/bot/tg/bot<YOUR_BOT_TOKEN>/<METHOD_NAME>

Доступные методы

getMe GET / POST

Возвращает базовую информацию о боте в виде объекта User.

// Example Response
{
  "ok": true,
  "result": {
    "id": 12345,
    "is_bot": true,
    "first_name": "My Awesome Bot",
    "username": "my_awesome_bot"
  }
}

sendMessage POST

Отправляет текстовые сообщения пользователям или в групповые каналы. Поддерживает ID пользователя, внутренний числовой ID или username.

Parameters (JSON Body):

chat_id (String) - Target user/group
text (String) - Message payload

// Payload Example {
"chat_id": "friend_username",
"text": "Hello from API Bot!"
}

setWebhook POST

Устанавливает URL для получения входящих обновлений через исходящие вебхуки.

Pass the url parameter specifying your server endpoint. Set to empty string to disable routing webhooks.

Как работают вебхуки

Вебхуки позволяют вашему боту получать обновления в реальном времени. Когда происходит событие (новое сообщение, добавление в группу), сервер Vibe отправляет HTTP POST запрос с JSON телом на указанный вами URL.

Безопасность и подписи

Для проверки подлинности запроса сервер отправляет заголовок `X-Vibe-Signature`, содержащий HMAC-SHA256 подпись тела запроса с использованием вашего Webhook Secret Token. Настоятельно рекомендуется проверять эту подпись на вашей стороне.

Повторные попытки

Если ваш сервер отвечает ошибкой (статус не 2xx) или недоступен, Vibe предпримет несколько повторных попыток отправки с экспоненциальной задержкой. Убедитесь, что ваш endpoint отвечает быстро (желательно за пару секунд), чтобы избежать задержек в очереди.

Лимиты API и ограничения

Для обеспечения стабильности платформы и предотвращения спама применяются динамические ограничения (Rate Limits) на запросы к API и доставку вебхуков.

Запросы к API: Для каждого токена действует ограничение на количество запросов в секунду (RPS). При превышении лимита сервер вернет статус `429 Too Many Requests`. Рекомендуется использовать экспоненциальную задержку при получении 429 статуса.

Webhooks: Существует ограничение на количество одновременных исходящих соединений (Concurrency) к вашему серверу. Если ваш сервер не справляется с нагрузкой, новые события будут ставиться в очередь. Обрабатывайте вебхуки асинхронно.

Отправка сообщений: Действуют дополнительные лимиты на массовую рассылку и массовое добавление в группы для предотвращения спама. Достижение этих лимитов может привести к временным автоматическим ограничениям работы бота.

📧

Если вам необходимо увеличить лимиты для вашего приложения, пожалуйста, свяжитесь с нами по электронной почте: support@v-vibe.ru

Шлюз реального времени

Боты также могут использовать наши нативные WebSocket (Socket.io) эндпоинты для потоковой передачи сообщений в реальном времени.