Запрос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-метод запроса.
ПараметрыЗапроса
| ПараметрыЗапроса: ПараметрыЗапроса |
| Доступность: Сервер |
Параметры запроса.
Прокси
| ТолькоЧтение Прокси: ИнтернетПрокси? |
| Доступность: Сервер |
Настройки прокси-сервера, которые будут использованы при выполнении данного запроса.
ТаймаутЗапроса
| ТолькоЧтение ТаймаутЗапроса: Длительность |
| Доступность: Сервер |
Таймаут для запросов.
ТаймаутСоединения
| ТолькоЧтение ТаймаутСоединения: Длительность |
| Доступность: Сервер |
Таймаут соединения с сервером.
Методы
Выполнить
Выполнить(Контекст: КонтекстHttp? = Неопределено): ОтветHttp| Доступность: Сервер |
Выполняет HTTP-запрос с контекстом Контекст и возвращает ответ.
ДобавитьЗаголовки
ДобавитьЗаголовки(Заголовки: ЧитаемыеЗаголовкиHttp): ЗапросHttp| Доступность: Сервер |
Добавляет все заголовки из заданной коллекции заголовков Заголовки. Возвращает текущий экземпляр.
ДобавитьЗаголовок
ДобавитьЗаголовок(
Заголовок: Строка,
Значение: Число|Строка|ЧитаемыйМассив<Число|Строка>
): ЗапросHttp| Доступность: Сервер |
Добавляет новый заголовок Заголовок со значением Значение. Запрещено устанавливать заголовки “Content-Length” и “Transfer-Encoding”. Возвращает текущий экземпляр.
ДобавитьПараметрЗапроса
ДобавитьПараметрЗапроса(
ИмяПараметра: Строка,
Значение: Строка|Обходимое<Объект>
): ЗапросHttp| Доступность: Сервер |
Добавляет Значение для параметра ИмяПараметра.
Возвращает текущий экземпляр ЗапросHttp.
ДобавитьПараметрыЗапроса
ДобавитьПараметрыЗапроса(ПараметрыЗапроса: ПараметрыЗапроса): Запрос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.
УстановитьПараметрыЗапроса
УстановитьПараметрыЗапроса(ПараметрыЗапроса: ПараметрыЗапроса): Запрос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| Доступность: Сервер |
Устанавливает значение ТипСодержимого заголовка “Content-Type”. Возвращает текущий экземпляр.