СОДЕРЖАНИЕ
- Где взять параметры (например, идентификатор тега)?
- Идентификатор контакта — в карточке контакта в разделе «Контакты»
- Как работать с методом API /fb/subscriber/setCustomField
- Как работать с методом API /fb/subscriber/findByCustomField
- Есть ли ограничение по количеству вызовов API?
- Что такое ключ API?
Из этой статьи вы узнаете, как сгенерировать токен для API ManyChat и где получить параметры.
Список всех команд API приведен на этом сайте.
Как сгенерировать и авторизовать токен
Для работы с API ManyChat необходимо сгенерировать токен. Перейдите в раздел «Настройки -> API» и нажмите на кнопку Сгенерировать ключ API.
Обратите внимание: в случае обновления или удаления токена все подключенные методы API будут отключены!
После успешной генерации вы можете поэкспериментировать с API в нашем Swagger. Он доступен по этой ссылке.
Чтобы добавить свой токен в Swagger, нажмите на кнопку «Authorize»:
Чтобы авторизовать токен, введите Bearer <ваш токен> и нажмите на кнопку «Authorize»:
Обновить или удалить токен также можно на вкладке «Настройки API».
Где взять параметры (например, идентификатор тега)?
Идентификатор контакта — в карточке контакта в разделе «Контакты»
- Flow_ns — из URL-адреса сценария:
- Идентификатор тега, идентификатор пользовательского поля — воспользуйтесь методом API /fb/page/getTags и получите список всех идентификаторов тегов. Идентификаторы пользовательских полей можно получить методом /fb/page/getCustomFields.
Как работать с методом API /fb/subscriber/setCustomField
В зависимости от типа пользовательского поля может потребоваться один из следующих типов данных для «field_value»:
- Текст — например, "text"
- Число — например, 123
- Логическое значение — например, "true" или "false"
- Дата — например, “2018-07-18”
- Дата и время — например, “2018-07-02T00:00:00+00:00"
Как работать с методом API /fb/subscriber/findByCustomField
Вы можете получить выборку пользователей, у которых в определенном пользовательском поле задано определенное значение.
- Этот метод API работает только с пользовательскими полями типа «Текст» или «Число».
- Результаты сортируются по времени последнего обновления значения пользовательского поля для данного пользователя.
- Возвращается не более 100 позиций списка.
Есть ли ограничение по количеству вызовов API?
Да, в ManyChat действует ограничение по числу запросов. Подробные сведения приведены в следующей таблице. При достижении лимита ManyChat может остановить обработку запросов на 24 часа.
| СТРАНИЦА /fb/page/getInfo /fb/page/getTags fb/page/getGrowthTools /fb/page/getCustomFields /fb/page/getOtnTopics /fb/page/getBotFields | 100 запросов в секунду |
| СТРАНИЦА /fb/page/getFlows | 10 запросов в секунду |
| СТРАНИЦА /fb/page/createTag /fb/page/removeTag /fb/page/removeTagByName /fb/page/createCustomField /fb/page/createBotField /fb/page/setBotField /fb/page/setBotFieldByName | 10 запросов в секунду |
| ОТПРАВКА /fb/sending/sendContent /fb/sending/sendContentByUserRef /fb/sending/sendFlow | 25 запросов в секунду |
| ПОДПИСЧИК /fb/subscriber/getInfo | 10 запросов в секунду |
| ПОДПИСЧИК /fb/subscriber/findByName /fb/subscriber/findByCustomField /fb/subscriber/findBySystemField | 100 запросов в секунду |
| ПОДПИСЧИК /fb/subscriber/addTag /fb/subscriber/addTagByName /fb/subscriber/removeTag /fb/subscriber/removeTagByName /fb/subscriber/setCustomField /fb/subscriber/setCustomFields /fb/subscriber/setCustomFieldByName /fb/subscriber/verifyBySignedRequest /fb/subscriber/createSubscriber /fb/subscriber/updateSubscriber | 10 запросов в секунду |
Что такое ключ API?
Это код, используемый для идентификации пользователя, разработчика или вызывающей программы на сайте. ManyChat предоставляет ключ API (функция PRO) для работы с открытым API аккаунта. Открытый ключ API можно найти в разделе «Настройки -> API».
Существует также открытый API профиля, используемый для подключения к чему-либо, не связанному с конкретным ботом, например к шаблонам. Для этого API необходим отдельный ключ, который можно получить здесь: https://manychat.com/profile/dashboard#settings.