Перейти к содержанию

Отправка результатов: Custom API

Платформа «Custom API» в блоке «Отправка результатов» позволяет после выполнения функции отправить HTTP-запрос во внешний сервис: получить, передать или обновить данные по документации выбранного API.

Настройка

  1. Откройте функцию агента и пролистните до подраздела «Отправка результатов».
  2. Добавьте платформу «Custom API».
  3. Укажите метод запроса (GET, POST, PUT, PATCH или DELETE) и URL endpoint.
  4. При необходимости заполните блоки ниже: параметры вызова, заголовки и тело запроса.
  5. Сохраните функцию.

Custom API

После сохранения при каждом успешном вызове функции система отправит запрос на указанный URL. Запрос считается успешным, если внешний сервис ответил кодом 2xx.

Запрос

  • Метод запроса — HTTP-метод (GET обычно для получения данных, POST/PUT/PATCH — для отправки или обновления).
  • URL — полный адрес endpoint, например https://api.example.com/clients. Допускаются только адреса http:// и https://.

Параметры вызова (params)

Query-параметры, которые добавляются к URL. Для каждой строки укажите:

  • Имя — имя параметра в запросе (например, location_id).
  • Источник — «Текст» или «Параметры из функции».
  • Значение / Параметр — фиксированный текст либо параметр функции, из которого берётся значение.

Блок можно оставить пустым, если query-параметры не нужны.

Заголовки запроса (headers)

HTTP-заголовки запроса. Для каждой строки укажите имя заголовка и значение (текст или параметр функции).

Типичные примеры:

  • Accept — ожидаемый формат ответа.
  • Content-Type — формат тела запроса (для JSON обычно application/json).
  • Authorization — токен доступа, например Bearer ….

Тело запроса (body)

Поля JSON-тела запроса. Обычно используются для POST, PUT и PATCH. Для каждой строки укажите имя поля и значение (текст или параметр функции).

Для GET тело часто не нужно — блок можно оставить пустым.

Примеры

GET — получить данные

  1. Метод: GET, URL внешнего API.
  2. В params передайте нужные идентификаторы (например, ID филиала из параметра функции).
  3. В headers укажите Accept и Authorization по документации сервиса.
  4. body оставьте пустым.

POST — отправить данные

  1. Метод: POST, URL внешнего API.
  2. В params при необходимости укажите query-параметры.
  3. В headers добавьте Accept, Content-Type и Authorization.
  4. В body сопоставьте поля API с параметрами функции (например, name ← client_name, phone ← client_phone).