API BotHelp
API интерфейс используется для того, чтобы интегрировать возможности BotHelp в личный проект клиента. API предназначен для разработчиков и сопровождается документацией.
Описание
REST API BotHelp работает по протоколу HTTP и представляет собой набор методов, с помощью которых совершаются запросы и возвращаются ответы для каждой операции. Все ответы приходят в виде JSON структур.
Ограничение на количество запросов зависит от конкретного метода (см. документацию).
Кросдоменные запросы (пример jQuery Ajax) запрещены.
Основной URL
Все ссылки на запросы к API в данной документации включают обязательный основной URL:
https://api.bothelp.io
Авторизация
Процесс авторизации возможен при наличии персонального ключа (токена), которым в дальнейшем должен быть подписан каждый запрос к API.
Код ключа (токен) передается в заголовке любого запроса (в "headers") кроме случаев получения самого токена, когда этот код не требуется.
Необходимые для получения ключа параметры можно найти в настройках кабинета: см. раздел “Интеграции”
Для получения ключа отправляется POST запрос по ссылке:
https://oauth.bothelp.io/oauth2/token
Для получения токена авторизации нужно отправлять данные в Form-data
Параметры запроса:
grant_type должен быть равен client_credentials
client_id ваш ID (API)
client_secret ваш секрет (API)
Пример ответа:
{
"access_token": "tf4Si1LydYpTAPyHXUgjig72jlrd5HpIJL5oigmc",
"token_type": "Bearer",
"expires_in": 3600
}
Пример ключа:
Authorization: Bearer tf4Si1LydYpTAPyHXUgjig72jlrd5HpIJL5oigmc
Примечание: Обратите внимание, что полученный ключ действителен в течение 1 часа и не требует повторного запроса при каждой операции. По истечении срока действия ключа (1 час) необходимо отправить повторный запрос на получение ключа
Возможности
Со списком доступных методов вы можете ознакомиться ↘ здесь ↘
Действия с данными подписчика
- выгрузить список подписчиков
- изменить параметры подписчика
- установить значение пользов. параметра
- установить/удалить метку
- фильтр по email позволяет получать всю информацию о своем подписчике с конкретным email
- Отправить сообщение
- Действия с ботом
- добавить подписчика в бота на определенный шаг
- остановить бота для подписчика
- Действия с авторассылкой
- добавить подписчика в авторассылку
- удалить подписчика из авторассылки
_______________________________________________________________________________________
Если вы не нашли ответ на свой вопрос, задайте его нам в чате внутри кабинета либо напишите на hello@bothelp.io 😃
Получите 14 дней полного функционала платформы для создания рассылок, автоворонок и чат-ботов BotHelp: