Отправить POST-запрос HttpClient::post
Модуль: main — подключать отдельно не нужно
Метод HttpClient::post отправляет POST-запрос и возвращает тело ответа.
Сигнатура метода в классе Bitrix\Main\Web\HttpClient:
public function post($url, $postData = null, $multipart = false)
Параметры
Обязательные параметры обозначены *
| Параметр | Тип | Описание |
|---|---|---|
| url* | string |
Задает абсолютный адрес |
| postData | array, string, resource или null |
Задает тело запроса. Метод кодирует массив как данные формы, отправляет строку как есть и читает ресурс потоком. По умолчанию — null, пустое тело |
| multipart | bool |
Значение true кодирует массив как multipart/form-data. Тогда файл передают ресурсом или массивом с ключами resource или content, filename и contentType. По умолчанию — false |
Типы в таблице описывают назначение аргументов. Сигнатура PHP не объявляет их.
Возвращаемое значение
Метод возвращает тело ответа строкой или false, если запрос не удался.
Особенности
- Если заголовок
Content-Typeне задан, метод отправляетapplication/x-www-form-urlencoded. Для JSON задайте заголовок методом setHeader и передайте строку. - В режиме
multipartметод сам задает заголовокContent-Typeс разделителем частей. - Метод переходит по заголовку
Locationпри любом коде ответа. После ответа 302 или 303 клиент повторяет запрос методом GET, после других ответов — методом POST с тем же телом. Если API отвечает на создание записи кодом 201 сLocation, выключите редиректы методом setRedirect.
Примеры
Пример. Код отправляет JSON и читает ответ:
<?php
use Bitrix\Main\Web\HttpClient;
use Bitrix\Main\Web\Json;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
$client = new HttpClient();
$client->setHeader('Content-Type', 'application/json');
$body = $client->post('https://postman-echo.com/post', Json::encode(['unit' => 'kg', 'count' => 3]));
$data = Json::decode($body);
echo $data['json']['unit'] . ' ' . $data['json']['count'];
Код выведет kg 3.
Пример. Код отправляет форму с файлом:
<?php
use Bitrix\Main\Web\HttpClient;
use Bitrix\Main\Web\Json;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
$client = new HttpClient();
$body = $client->post('https://postman-echo.com/post', [
'catalog' => 'units',
'file' => ['content' => "code;name\nkg;Kilogram", 'filename' => 'units.csv', 'contentType' => 'text/csv'],
], true);
$data = Json::decode($body);
echo $data['form']['catalog'] . ' ' . implode(',', array_keys($data['files']));
Код выведет units units.csv.
Смотрите также
Была ли статья полезна?
Предыдущая
Следующая