Интеграции, API и автоматизация
Как использовать REST API, ключи доступа, вебхуки, бот-сценарии и экспорт данных для подключения вашего мессенджера к внешним системам.
ChatsForge — это не только визуальный конструктор. Если вы (или ваш разработчик) хотите подключить мессенджер к внешним системам, автоматизировать ответы или выгружать данные, для этого есть набор инструментов для разработчиков. На этой странице мы по порядку разберём REST API, ключи доступа, проводник по API, вебхуки, бот-сценарии и экспорт данных. Не пугайтесь технических слов — каждый раздел объяснён простыми словами.
Эти возможности предназначены для программного доступа. Чтобы просто настроить и опубликовать мессенджер, они не нужны — используйте обычный конструктор. API нужен, когда вы хотите связать мессенджер с другим сервисом.
REST API
REST API — это способ обращаться к ChatsForge не через интерфейс, а напрямую из кода. С его помощью программа может, например, прочитать данные мессенджера или отправить сообщение. API версионирован: все запросы идут по адресам, начинающимся с /v1. Версия в адресе означает, что даже если в будущем API изменится, ваши существующие интеграции продолжат работать.
Ключи API
Чтобы API понимал, что запрос идёт именно от вас, нужен ключ API. Создать и отозвать ключи можно в Панели управления. Ключ передаётся в каждом запросе как Bearer-токен в заголовке Authorization.
- Откройте Панель управления и перейдите в раздел ключей API.
- Создайте новый ключ и сразу скопируйте его — полное значение обычно показывается только один раз.
- Храните ключ в надёжном месте и никогда не публикуйте его в открытом коде или на клиенте.
- Если ключ скомпрометирован, отзовите его в той же панели — после этого он перестанет работать.
Ключ API даёт доступ к вашим данным — относитесь к нему как к паролю. Не храните его в публичных репозиториях и не вставляйте в код, который выполняется в браузере у пользователей. Если есть подозрение на утечку — немедленно отзовите ключ и создайте новый.
Вот как выглядит типичный запрос с авторизацией по ключу. Заголовок Authorization: Bearer ВАШ_КЛЮЧ_API сообщает API, кто вы:
curl -X POST https://your-domain.com/api/v1/messengers/MESSENGER_ID/messages \
-H "Authorization: Bearer ВАШ_КЛЮЧ_API" \
-H "Content-Type: application/json" \
-d '{"text": "Привет из API!"}'Проводник по API
Чтобы не писать код только ради проверки, в Панели управления есть проводник по API. Он позволяет выбрать эндпоинт, подставить ключ и параметры и выполнить запрос прямо из браузера, сразу увидев ответ. Это удобный способ изучить API и убедиться, что ключ работает, прежде чем встраивать вызовы в своё приложение.
Вебхуки
Вебхуки работают в обратную сторону: вместо того чтобы вы постоянно спрашивали API «что нового?», ChatsForge сам уведомляет вашу систему, когда происходит событие. Вы указываете URL, и при наступлении события (например, новое сообщение) ChatsForge отправляет на этот адрес HTTP-запрос с данными о событии. Так можно строить автоматизацию, не делая лишних запросов.
Входящие вебхуки
Входящие вебхуки — это противоположное направление: они позволяют отправлять сообщения в мессенджер извне. Вы получаете специальный адрес, и любая внешняя система может сделать на него запрос, чтобы опубликовать сообщение в мессенджере. Это удобно, например, для уведомлений из другого сервиса или CRM.
Бот-сценарии
Бот-сценарии позволяют настроить автоматические ответы и последовательности действий без постоянного участия человека. С их помощью мессенджер может, например, автоматически реагировать на сообщения пользователей по заданным правилам. Это удобно для приветствий, типовых ответов и простых сценариев общения.
Экспорт данных
Экспорт данных позволяет выгрузить данные мессенджера, чтобы сохранить их у себя или перенести в другую систему. Это функция тарифа Business — доступность зависит от вашего плана. Подробности и условия смотрите на странице тарифов.
Нужно ли мне уметь программировать, чтобы пользоваться ChatsForge?+
Нет. Создание, настройка и публикация мессенджера полностью выполняются в визуальном конструкторе. API и вебхуки нужны только тем, кто хочет подключить мессенджер к внешним системам или автоматизировать процессы.
Где взять ключ API?+
Ключи создаются и отзываются в Панели управления. Скопируйте ключ сразу после создания и храните его в безопасном месте.
Чем вебхуки отличаются от входящих вебхуков?+
Вебхуки уведомляют вашу систему, когда в мессенджере что-то происходит. Входящие вебхуки работают наоборот — позволяют отправить сообщение в мессенджер из внешней системы.
Доступен ли экспорт данных на любом тарифе?+
Экспорт данных — это функция тарифа Business. Актуальные условия смотрите на странице тарифов.