Отправить GET-запрос HttpClient::get
Модуль: main — подключать отдельно не нужно
Метод HttpClient::get отправляет GET-запрос и возвращает тело ответа. Метод переходит по редиректам, если их не выключил метод setRedirect.
Сигнатура метода в классе Bitrix\Main\Web\HttpClient:
public function get($url)
Параметры
Обязательные параметры обозначены *
| Параметр | Тип | Описание |
|---|---|---|
| url* | string |
Задает абсолютный адрес со схемой http или https, например https://example.com/api/?id=1 |
Тип в таблице описывает назначение аргумента. Сигнатура PHP не объявляет его.
Возвращаемое значение
Метод возвращает тело ответа строкой. Если запрос не удался, например сервер недоступен или адрес неверный, метод возвращает false. Метод getError возвращает описание ошибки.
Особенности
- Метод возвращает тело и для ответа с кодом ошибки, например 404 или 500. Проверяйте код методом getStatus.
- Если задан поток setOutputStream, метод записывает тело ответа в поток и возвращает пустую строку.
Примеры
Пример. Код запрашивает 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(['socketTimeout' => 10, 'streamTimeout' => 10]);
$body = $client->get('https://postman-echo.com/get?unit=kg');
if ($body !== false && $client->getStatus() === 200)
{
$data = Json::decode($body);
echo $data['args']['unit'];
}
else
{
echo 'request failed';
}
Код выведет kg.
Смотрите также
Была ли статья полезна?
Предыдущая
Следующая