ЗапросHttp
Стд::Http::ЗапросHttp
Доступность: Сервер
Настраиваемый и исполняемый HTTP-запрос к серверу.
При работе с URL-адресом существуют поддерживаемые и запрещенные символы. Все неподдерживаемые символы должны быть процент-кодированы. При этом, поддерживаемые символы (зарезервированные символы, разделители сегментов адреса, разделители внутри сегментов и т.д.) могут быть представлены как в натуральном, так и процент-кодированном виде. Во входящей строке ЗапросHttp сохраняются процент-кодированные представления символов, недопустимые символы будут заменены. Допустимыми являются все разделители внутри сегментов, которые указаны в стандарте RFC 3986: "!", "&", "'", "+", "*", "$", "(", ")", ",", ";", "=". Также для сегментов запрос и фрагмент допустимы "/", "?". Символы, которые являются разделителями сегментов, не меняются ":", "/", "?", "#", "[", "]", "@". Не меняются разрешенные к использованию во всех частях url-адреса символы: "-", ".", "_", "~". Если во входящей строке представлены символы национальных алфавитов, то они также кодируются. Если такие символы идут в доменной части строки, то происходит IDN кодирование. Если в других частях url - процентное-кодирование символов.
Сравнение ссылочное
Иерархия типа
Базовые типы: Объект
Примеры
Аутентификация по пользователю и паролю
знч Аутентификация = новый АутентификацияHttp("пользователь", "пароль")
знч Запрос = КлиентHttp.ЗапросGet("http://адрес")
исп Ответ = Запрос.УстановитьАутентификацию(Аутентификация).Выполнить()
Запрос курса валют:
// формирование запроса 'https://free.currconv.com/api/v7/convert?apiKey=YOUR_API_KEY&compact=ultra&q=USD_RUB&q=EUR_RUB'
знч КЛЮЧ_АПИ = "YOUR_API_KEY"
знч Запрос = КлиентHttp.ЗапросGet("https://free.currconv.com/api/v7/convert")
.ДобавитьПараметрЗапроса("apiKey", КЛЮЧ_АПИ)
.ДобавитьПараметрЗапроса("compact", ultra)
.ДобавитьПараметрЗапроса("q", ["USD_RUB", "EUR_RUB"])
исп Ответ = Запрос.Выполнить()
Запрос в Google c заменой параметра:
знч БазовыйАдрес = "https://google.ru?q=шаблон"
знч ЗначениеПоиска = "1С:Предприятие. Элемент"
знч Запрос = КлиентHttp.ЗапросGet(БазовыйАдрес)
.УстановитьПараметрЗапроса("q", ЗначениеПоиска)
исп Ответ = Запрос.Выполнить()
Свойства
АбсолютныйUrl
Доступность: Сервер
ТолькоЧтение
АбсолютныйUrl: Строка
Декодированный URL-адрес, к которому будет выполняться запрос. Даже если в запросе был указан относительный путь, это свойство будет содержать абсолютный путь к запрошенному ресурсу.
Аутентификация
Доступность: Сервер
ТолькоЧтение
Аутентификация: АутентификацияHttp?
Данные аутентификации при выполнении этого запроса.
Заголовки
Доступность: Сервер
Заголовки: ЗаголовкиHttp
Заголовки запроса.
МаксимумПеренаправлений
Доступность: Сервер
ТолькоЧтение
МаксимумПеренаправлений: Число
Максимальное количество переходов.
МетодHttp
Доступность: Сервер
ТолькоЧтение
МетодHttp: Строка
Возвращает HTTP-метод запроса.
ПараметрыЗапроса
Доступность: Сервер
ПараметрыЗапроса: ПараметрыUrl
Параметры запроса.
Прокси
Доступность: Сервер
ТолькоЧтение
Прокси: ИнтернетПрокси?
Настройки прокси-сервера, которые будут использованы при выполнении данного запроса.
ТаймаутЗапроса
Доступность: Сервер
ТолькоЧтение
ТаймаутЗапроса: Длительность
Таймаут для запросов.
ТаймаутСоединения
Доступность: Сервер
ТолькоЧтение
ТаймаутСоединения: Длительность
Таймаут соединения с сервером.
Методы
Выполнить
Доступность: Сервер
Выполнить(Контекст: КонтекстHttp? = Неопределено): ОтветHttp
Выполняет HTTP-запрос с контекстом Контекст
и возвращает ответ.
ДобавитьЗаголовки
Доступность: Сервер
ДобавитьЗаголовки(Заголовки: ЧитаемыеЗаголовкиHttp): ЗапросHttp
Добавляет все заголовки из заданной коллекции заголовков Заголовки
.
Возвращает текущий экземпляр.
ДобавитьЗаголовок
Доступность: Сервер
ДобавитьЗаголовок(
Заголовок: Строка,
Значение: Число|Строка|ЧитаемыйМассив<Число|Строка>
): ЗапросHttp
Добавляет новый заголовок Заголовок
со значением Значение
.
Запрещено устанавливать заголовки "Content-Length" и "Transfer-Encoding".
Возвращает текущий экземпляр.
ДобавитьПараметрЗапроса
Доступность: Сервер
ДобавитьПараметрЗапроса(
ИмяПараметра: Строка,
Значение: Строка|Обходимое<Строка>
): ЗапросHttp
Добавляет Значение
для параметра ИмяПараметра
.
Возвращает текущий экземпляр ЗапросHttp
.
ДобавитьПараметрыЗапроса
Доступность: Сервер
ДобавитьПараметрыЗапроса(ПараметрыЗапроса: ПараметрыUrl): ЗапросHttp
Добавляет все параметры запроса из ПараметрыЗапроса
.
Возвращает текущий экземпляр ЗапросHttp
.
ОчиститьЗаголовки
Доступность: Сервер
ОчиститьЗаголовки(): ЗапросHttp
Удаляет все заголовки. Возвращает текущий экземпляр.
ОчиститьПараметрыЗапроса
Доступность: Сервер
ОчиститьПараметрыЗапроса(): ЗапросHttp
Очищает параметры запроса.
Возвращает текущий экземпляр ЗапросHttp
.
УдалитьЗаголовок
Доступность: Сервер
УдалитьЗаголовок(Заголовок: Строка): ЗапросHttp
Удаляет заголовок с именем Заголовок
(если есть).
Возвращает текущий экземпляр.
УдалитьПараметрЗапроса
Доступность: Сервер
УдалитьПараметрЗапроса(ИмяПараметра: Строка): ЗапросHttp
Удаляет все значения параметра ИмяПараметра
из параметров запроса.
Возвращает текущий экземпляр ЗапросHttp
.
УстановитьCookies
Доступность: Сервер
УстановитьCookies(Cookies: Строка): ЗапросHttp
Устанавливает значение Cookies
заголовка "Cookies".
Возвращает текущий экземпляр.
УстановитьUserAgent
Доступность: Сервер
УстановитьUserAgent(UserAgent: Строка): ЗапросHttp
Устанавливает значение UserAgent
заголовка "UserAgent".
Возвращает текущий экземпляр.
УстановитьАутентификацию
Доступность: Сервер
УстановитьАутентификацию(Аутентификация: АутентификацияHttp?): ЗапросHttp
Устанавливает данные аутентификации при выполнении этого запроса. Возвращает текущий экземпляр.
УстановитьЗаголовки
Доступность: Сервер
УстановитьЗаголовки(Заголовки: ЧитаемыеЗаголовкиHttp): ЗапросHttp
Очищает заголовки и копирует все заголовки из заданной коллекции Заголовки
.
Запрещено устанавливать заголовки "Content-Length" и "Transfer-Encoding".
Возвращает текущий экземпляр.
УстановитьЗаголовок
Доступность: Сервер
УстановитьЗаголовок(
Заголовок: Строка,
Значение: Число|Строка|ЧитаемыйМассив<Число|Строка>
): ЗапросHttp
Устанавливает значение Значение
заголовка Заголовок
.
Запрещено устанавливать заголовки "Content-Length" и "Transfer-Encoding".
Возвращает текущий экземпляр.
УстановитьМаксимумПеренаправлений
Доступность: Сервер
УстановитьМаксимумПеренаправлений(Количество: Число): ЗапросHttp
Устанавливает максимальное количество перенаправлений Количество
.
Возвращает текущий экземпляр.
УстановитьПараметрЗапроса
Доступность: Сервер
УстановитьПараметрЗапроса(
ИмяПараметра: Строка,
Значение: Строка|Обходимое<Строка>
): ЗапросHttp
Устанавливает Значение
для параметра ИмяПараметра
. Если значения параметра уже были установлены, то они будут заменены.
Возвращает текущий экземпляр ЗапросHttp
.
УстановитьПараметрыЗапроса
Доступность: Сервер
УстановитьПараметрыЗапроса(ПараметрыЗапроса: ПараметрыUrl): ЗапросHttp
Очищает установленные параметры запроса и копирует все параметры запроса из ПараметрыЗапроса
.
Возвращает текущий экземпляр ЗапросHttp
.
УстановитьПрокси
Доступность: Сервер
УстановитьПрокси(Прокси: ИнтернетПрокси?): ЗапросHttp
Устанавливает настройки прокси-сервера Прокси
, которые будут использованы при выполнении данного запроса.
Возвращает текущий экземпляр.
УстановитьТаймаутЗапроса
Доступность: Сервер
УстановитьТаймаутЗапроса(Таймаут: Длительность): ЗапросHttp
Устанавливает значение таймаута Таймаут
выполнения этого за проса.
Возвращает текущий экземпляр.
УстановитьТаймаутСоединения
Доступность: Сервер
УстановитьТаймаутСоединения(Таймаут: Длительность): ЗапросHttp
Устанавливает время ожидания Таймаут
установки соединения для этого запроса.
Возвращает текущий экземпляр.
УстановитьТело
Доступность: Сервер
УстановитьТело(Тело: ДвоичныйОбъект): ЗапросHttp
УстановитьТело(Тело: Строка): ЗапросHttp
УстановитьТело(Файл: Файл): ЗапросHttp
УстановитьТело(Поток: ПотокЧтения): ЗапросHttp
УстановитьТело(Поток: ПотокЧтения, Размер: РазмерБайтов|Число): ЗапросHttp
Устанавливает тело запроса из двоичных данных Тело
.
Возвращает текущий экземпляр.
УстановитьТело
Доступность: Сервер
УстановитьТело(Тело: Строка): ЗапросHttp
УстановитьТело(Файл: Файл): ЗапросHttp
УстановитьТело(Поток: ПотокЧтения): ЗапросHttp
УстановитьТело(Поток: ПотокЧтения, Размер: РазмерБайтов|Число): ЗапросHttp
УстановитьТело(Тело: ДвоичныйОбъект): ЗапросHttp
Устанавливает тело запроса из строки Тело
.
Возвращает текущий экземпляр.
УстановитьТело
Доступность: Сервер
УстановитьТело(Файл: Файл): ЗапросHttp
УстановитьТело(Тело: Строка): ЗапросHttp
УстановитьТело(Поток: ПотокЧтения): ЗапросHttp
УстановитьТело(Поток: ПотокЧтения, Размер: РазмерБайтов|Число): ЗапросHttp
УстановитьТело(Тело: ДвоичныйОбъект): ЗапросHttp
Устанавливает тело запроса из файла Файл
.
Непосредственно чтение из файла выполняется в момент выполнения запроса.
Возвращает текущий экземпляр.
УстановитьТело
Доступность: Сервер
УстановитьТело(Поток: ПотокЧтения): ЗапросHttp
УстановитьТело(Тело: Строка): ЗапросHttp
УстановитьТело(Файл: Файл): ЗапросHttp
УстановитьТело(Поток: ПотокЧтения, Размер: РазмерБайтов|Число): ЗапросHttp
УстановитьТело(Тело: ДвоичныйОбъект): ЗапросHttp
Устанавливает тело запроса из потока Поток
.
Запрос будет выполнен с использованием механизма Chunked transfer encoding.
Непосредственно чтение из потока выполняется в момент выполнения запроса.
После выполнения запроса поток будет закрыт.
Возвращает текущий экземпляр.
УстановитьТело
Доступность: Сервер
УстановитьТело(
Поток: ПотокЧтения,
Размер: РазмерБайтов|Число
): ЗапросHttp
УстановитьТело(Тело: Строка): ЗапросHttp
УстановитьТело(Файл: Файл): ЗапросHttp
УстановитьТело(Поток: ПотокЧтения): ЗапросHttp
УстановитьТело(Тело: ДвоичныйОбъект): ЗапросHttp
Устанавливает тело запроса из потока Поток
указанного размера Размер
.
Непосредственно чтение из потока выполняется в момент выполнения запроса.
После выполнения запроса поток будет закрыт.
Возвращает текущий экземпляр.
УстановитьТипСодержимого
Доступность: Сервер
УстановитьТипСодержимого(ТипСодержимого: Строка): ЗапросHttp
Устанавливает значение ТипСодержимого
заголовка "Content-Type".
Возвращает текущий экземпляр.