help.chat-api.com

Как создать и настроить новую цепочку API?

Для создания новой цепочки API нужно перейти в одноименный раздел Вашего Личного кабинета Chat API и выбрать «Добавить новую Цепочку». Для Вашего удобства вид странички можно модерировать и выводить цепочки списком или таблицей.  

Далее выбираем один из следующих шаблонов: 

1 - Default template - Стандартный шаблон цепочки API с базовыми настройками. Вы можете самостоятельно выбрать дополнительные звенья(задачи) цепи;
2 - Google translate template - Шаблон цепочки с двусторонним переводом сообщений через Google Translate. Для работы с данной цепочкой необходимо настроить Google Key для доступа к Google API;
3 - Menubot template - Шаблон цепочки с подключением к возможностям нашего бесплатного Чатбота. Для работы с данной цепочкой необходимо иметь настроенный шаблон MenuBot. Сделать это возможно в соответствующем разделе Вашего личного кабинета. 
4 - Google sheets template - Шаблон цепочки для сохранения данных в Google таблицах. Требует создания OAuth2 ключа и прохождения этапа авторизации.

Каждый представленный вариант шаблона цепочки уже настроен на работу, Вам только остается заполнить необходимые поля.

Дальнейшая настройка цепочки:

Обратите внимание на Адрес и Ключ (токен).

На данный адрес необходимо заменить бывший запрос к Вашему инстансу.
Ключ или токен – укажите данный токен вместо предыдущего токена, который использовался для доступа к инстансу.

Кнопка «Показать логи» - «обновить логи» - демонстрирует или скрывает все доступные логи на страничке. Логи появляются после запроса к цепочкам. Логи автоматически обновляются каждые 2-3 минуты. Кнопка обновить логи принудительно обновляет их по Вашему запросу.

Статусы сервера или звеньев цепочки

Данные статусы представлены в правом верхнем углу каждого звена. Они отображают рабочую ситуацию звена, сигнализируют об ошибках или о необходимости дополнительных настроек.

Слева направо:

1 – «Ошибка в настройке сервера» - сигнализирует о том, что звено настроено неверно. Пройдитесь еще раз по этапам настройки, что-то было упущено;
2 – «Ошибка при исполнении запроса к серверу» - просмотрите логи, ошибка произошла во время исполнения кода на сервере;
3 – «Все работает отлично» - если "горит" данная иконка, то больше не о чем волноваться. Вы все сделали верно;
4 – «Есть логи для отображения» - вам доступны логи для просмотра.

Дальнейшая настройка звена, поэтапные элементы

Каждое звено содержит ряд настроек, которые необходимо выполнить. Если предыдущий этап настройки был выполнен неверно, то он будет красным и все последующие этапы настройки не будут доступны.

Если все выполнено верно, то иконка загорается зеленым. Вы можете приступать к настройке следующего раздела.

Статистические поля

Это данные, которые должны оставаться неизменными в процессе работы цепочки. Как правило, это может быть ключ API для доступа, который меняться не должен. Данные легко можно сделать динамическими, для этого есть специальная кнопка - «Сделать динамическим».

Динамические поля

Это данный, которые нам необходимо вычленить из общего потока, чаще всего их можно найти во время теста в логах. Общий пул данных складывается из того, что мы ранее сохраняли в цепочку. Все параметры первоначального запроса сразу же сохраняются в общий пул, например, обычный запрос к инстансу содержит «Body» и «instanceId», если повторить этот же запрос к цепочкам, то мы сможем сохранить эти данные по этим же параметрам. Доступ к более глубоким запросам осуществляется через нотацию `.` например, вебхук инстанса отправляет нам данные вида:

Чтобы получить доступ к тексту сообщения в динамических данных мы должны указать «messages.0.body». В это поле также можно прописать `...`, это приведет к тому, что в выбранное поле будут приняты все возможные значения. Справа можно заметить кнопку “сделать статическим”, которое переведет поле в статическое.

Настройка запросов

Этот раздел поможет Вам настроить процесс и формат отправки запросов через такие критерии как количество повторных запросов и паузы между ними.

Таймаут – сколько миллисекунд будет ожидаться ответ от сервера звена цепочки. По умолчанию ответ ожидается 6000 миллисекунд.

Количество повторных запросов -  если цепочки считают запрос неудачным, то можно указать количество повторных обращений к серверу. Всего Вам доступно от 1 до 5 попыток.

Игнорировать ошибки – по умолчанию цепочки прекращают работу, если на пути выполнения запроса возникла ошибка. Если для Вас важно, чтобы цепочка не останавливала выполнение звеньев, то укажите данный параметр. 


Условие выполнения

Этот этап определяет условия, при выполнении которых запустится выбранное звено. Это полезно, когда важно фильтровать какие запросы будут обрабатываться звеном, а какие можно игнорировать. Например, обработка только входящих текстовых сообщений. В некоторых шаблонах уже изначально присутствуют заложенные условия выполнения. Шаблон с Google переводчиком обрабатывает только простые текстовые сообщения, чтобы избежать перевода, скажем, url картинки или других неформатных сообщений.  

- В первом разделе, как и в динамическом поле, указываем откуда будет браться значение.
- Во втором, указываем тип данных, который мы ожидаем получить.
- В третьем – сравнение.
- В четвертом, указываем значение, с которым будет проводиться сравнение. Раздел можно оставить пустым для сравнения с "пустотой".

Например, если body в данном примере будет НЕ пустое, то звено запустится

Но если body окажется пустым, то звено не запустится.

Информацию о настройке средних звеньев(доступных API  и Web приложений) Вы можете найти здесь – Настройка средних звеньев.

Информацию о настройке нижнего звена (инстанса) здесь – Настройка инстанса.

Была ли эта статья полезной?

Ваше мнение будет использовано для улучшения содержания статьи

Самый Многофункциональный WhatsApp API провайдер

Chat API работает с 2015 года и является одним из первых и самых крупных провайдеров в восточной Европе.

Вот несколько любопытных и важных цифр:

  • У нас огромная экспертиза в управлении докер контейнерами на масштабе с SLA 99.5+%;
  • Chat API задействует в своей работе более 200 серверов, с возможностью оперативного подключения еще 100;
  • 3200 ядер и 25 терабайт оперативной памяти;
  • 200+ методов и функций WhatsApp, которые продолжают пополняться;
  • Highload система, сервера Up Time 99,9%;
  • Служба поддержки 24\7;
Получить доступ к WhatsApp API