Блок API делает HTTP-запрос: GET, POST, PUT, PATCH, DELETE. Используйте его, когда готового блока канала нет, а у сервиса есть обычный HTTP-интерфейс.
Настройки
- URL — адрес, в том числе со вставками
<блок.поле> - Метод — GET читает, POST создаёт, PUT/PATCH обновляют, DELETE удаляет
- Заголовки — например
Authorizationиз переменной окружения - Параметры запроса — пары ключ–значение в строке адреса
- Тело — JSON или форма для POST/PUT/PATCH
API (Application Programming Interface — программный интерфейс) здесь означает обычный HTTP-вызов, не отдельный продукт.
Выходы
Ответ сервиса доступен следующим блокам: тело, код статуса, заголовки. Если сервис вернул JSON, поля можно читать по пути.
Когда не этот блок
Для Битрикс24, amoCRM, MAX и VK есть готовые страницы в инструментах: там уже разобраны токены и подлинность вебхука (входящего HTTP-запроса). Блок API не подставляет их правила за вас.