help.chat-api.com

Настройка сервера цепочки messengers API

После выбора шаблона цепочки Вам необходимо настроить сервер. На сервер будут возвращаться все ответы от выбранного инстанса. Вы можете указать свой сервер для приема и обработки данных или же воспользоваться нашим Docker хостингом. Если оба варианта для Вас не подходят, то Вы можете указать Url вебхука с WebHook.site для обработки данных. 

Настройка сервера состоит из опциональной информации и не опциональной. Если обязательные поля будут заполнены некорректно, то цепочка выдаст ошибку, поэтому следует внимательно отнестись к заполняемым полям.


 

Наименование сервера

Это имя Вашего сервера. Соответственно в дальнейшем оно будет отображаться при работе с цепочкой и выборе карточки настроек сервера.

Метод сервера

Указывается метод, по которому ожидает доступ Ваш сервер. Другими словами, метод указывает на то действие, которое будет совершенно сервером. Всего их несколько:

- GET –  получение ресурса;
- POST –  создание ресурса;
- PUT –  обновление ресурса;
- DELETE –  удаление ресурса;
- OPTIONS – определение параметров;
- PATCH – вариант обновления ресурса.

Url сервера

Url - единообразный идентификатор ресурса. Соответственно указываем по какому адресу будет доступен сервер. Напоминаем, что для указания Url Вы можете воспользоваться нашим Docker хостингом или же взять Url с Webhook. site.

Заголовки  

Они же хедеры или Headers. В заголовках передается различная служебная информация, например, кодировка сообщений. В этом поле нужно указать какие заголовки будет ожидать Ваш сервер. Если их несколько, то их можно добавить с помощью соответствующей кнопки. По умолчанию в заголовках будет присутствовать настройка для json запроса.

Все последующие поля настройки (заголовков и даты) включают себя по 3 инпута и по 1 чекбоксу. 

В имени ключа прописываем наименование ключа, которое ожидается в ответе.

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

В инпуте «по умолчанию» указывается какое значение будет по умолчанию у этого поля. Можно ничего не указывать, но если поле не было опциональным, то далее придется настраивать его вручную.

Выбор «статический» или «динамический» определит к каким данным относится это поле. Если Вам необходимо работать с данными, которые должны оставаться неизменными, например API KEY, то выбираем статический, если же нет, то динамический. Характеристику поля всегда можно изменить.

Например, если Вам нужен авторизованный токен, то вариант настройки заголовка приобретает следующий вид:

 

Data

Data также является body запроса или самими передаваемыми данными. Data всегда присылается в Json варианте. В данном поле необходимо указать, какие параметры пользователь ожидает увидеть в ответе от сервера, как минимум должен быть указан хотя бы один параметр, иначе цепочка не будет активна. Если Вы хотите получить все, что содержится в body, то воспользуйтесь данной настройкой и пропишите в разделе «По умолчанию» - «…».

Если же вам, к примеру, необходим только ответ сопоставимый с ответом вебхука, Вы можете добавить все ключи, которые Вы ожидаете в опциональную дату:

 

 

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

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

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

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

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

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