Коннектор: удобный HTTP-клиент для 1С:Предприятие 8

Публикация № 709325

Программирование - Инструментарий

http post get cookie ssl url multipart/form-data x-www-form-urlencoded gzip редирект digest дайджест аутентификация https

271
Коннектор - библиотека для работы с HTTP запросами. Библиотека берет на себя всю рутину работы с HTTP запросами. Буквально в одну строку можно получать данные, отправлять, не заботясь о необходимости конструирования URL, кодирования данных и т.п.

Коннектор: удобный HTTP-клиент для 1С:Предприятие 8

В мире python очень популярна библиотека для работы с HTTP запросами - Requests (автор: Kenneth Reitz). Библиотека берет на себя всю рутину работы с HTTP запросами. Буквально в одну строку можно получать данные, отправлять, не заботясь о необходимости конструирования URL, кодирования данных и т.п. В общем библиотека очень мощная и проста в использовании.

Коннектор - это "Requests" для мира 1С.

Возможности

Основные возможности библиотеки:

  • Передача параметров в строку запроса (в URL)
  • Удобная работа с запросами и ответами в формате JSON
  • Отправка данных формы (полей формы), application/x-www-form-urlencoded
  • Отправка данных формы (полей формы и файлов), multipart/form-data
  • Прозрачная поддержка ответов, закодированных GZip
  • Basic и Digest аутентификация
  • Автоматическое разрешение редиректов
  • Установка и чтение Cookies
  • Работа в рамках сессии с сохранением состояния (cookies, аутентификация и пр.)
  • И многое другое

Требования

Платформа 8.3.10 и выше.

Использование

Скопируйте общий модуль к себе в конфигурацию.

Пример мощи библиотеки

Чем же хороша библиотека? Давай уже покажи пример.

Получим данные JSON с помощью GET-запроса:

Вот так это делается стандартными средствами 1С

ЗащищенноеСоединение = Новый ЗащищенноеСоединениеOpenSSL(Неопределено, Новый СертификатыУдостоверяющихЦентровОС);
Соединение = Новый HTTPСоединение("api.github.com", 443,,,, 30, ЗащищенноеСоединение);
Запрос = Новый HTTPЗапрос("/events");
Ответ = Соединение.Получить(Запрос);
Поток = Ответ.ПолучитьТелоКакПоток();
Кодировка = "utf-8"; // ну допустим мы знаем что там такая кодировка

Ридер = Новый ЧтениеJSON;
Ридер.ОткрытьПоток(Поток, Кодировка); // Кодировка в заголовке ответа
Результат = ПрочитатьJSON(Ридер);
Ридер.Закрыть();

А вот так с помощью Коннектора

Результат = КоннекторHTTP.GetJson("https://api.github.com/events");

Все! В Результат будет десериализованный из JSON ответ сервера. При этом:

  • Библиотека сама разбила URL на составляющие
  • Установила защищенное соединение
  • Определила кодировку ответа из заголовков
  • Десериализовала JSON

И это достаточно простой пример. Всю мощь библиотеки рассмотрим далее.

 
Передача параметров в строку запроса (в URL)
 
Произвольные HTTP заголовки
 
Работа с JSON
 
Отправка данных формы
 
Отправка файла
 
Отправка файлов и данных формы
 
Содержимое ответа
 
GZip-декодирование
 
Таймаут
 
Basic-аутентификация
 
Digest-аутентификация
 
Доступ через прокси-сервер
 
Поддерживаемые HTTP методы
 
Редиректы (Перенапраления)
 
Проверка сервернего сертификата SSL
 
Клиентские сертификаты
 
Работа с Cookies
 
Работа в рамках сессии

 

UPDATE: Доступна версия для 1Script

opm install 1connector

271

Скачать файлы

Наименование Файл Версия Размер
Коннектор: удобный HTTP-клиент для 1С:Предприятие 8:
.cf 29,48Kb
30.01.19
75
.cf 1.1.6 29,48Kb 75 Скачать

См. также

Специальные предложения

Вознаграждение за ответ
Показать полностью
Лучшие комментарии
46. bonv 647 18.02.19 19:56 Сейчас в теме
UPDATE: Доступна версия для 1Script
opm install 1connector
Merc; GreenDragon; +2 Ответить
Остальные комментарии
Избранное Подписка Сортировка: Древо
1. user1131250 31.01.19 08:02 Сейчас в теме
Плюсанул на звездочке. Ну, круто, чувак, круто, поздравляю! :)
2. Labotamy 31.01.19 08:11 Сейчас в теме
(1)не автора надо поздравлять, а слобщество. Поздравляю всех 1с ников с появлением request!
3. Labotamy 31.01.19 08:12 Сейчас в теме
Требую включения в состав БСП))
6. zeegin 35 31.01.19 09:25 Сейчас в теме
(3) БСП поставляется по CC-BY, а тут Apache. Разве можно включить?

https://softwareengineering.stackexchange.com/questions/170185/is-creative-commons-license-compatible-with-apache-license

Вот ребята пишут что нельзя.
18. Labotamy 31.01.19 16:37 Сейчас в теме
(6)Тогда точно такой же, только больше и другой =))
20. bonv 647 31.01.19 16:57 Сейчас в теме
(6) всегда можно договориться )
21. zeegin 35 31.01.19 20:43 Сейчас в теме
(20) Я бы с удовольствием всю подсистему получения файлов из интернета заменил на это, за исключением настроек прокси: их всегда брать из настроек БСП и не предлагать переопределять.
4. krollzlat 31.01.19 09:14 Сейчас в теме
Отлично ,жалко не хватает СМ.Когда рекод работаешь с http забывается...А тут и шпоргалка и удобство.
12. the1 328 31.01.19 12:11 Сейчас в теме
(4) Народ, переведите кто-нибудь? Хотелось бы, так сказать, в общих чертах понять, что интурист говорит.
51. leemuar 19.02.19 16:59 Сейчас в теме
(12) "Отличная разработка! Жалко стартмани не хватает, чтобы скачать. Когда редко работаешь с http - забывается. А тут и документация отличная, и сама библиотека удобная"
5. toypaul 64 31.01.19 09:20 Сейчас в теме
7. leemuar 31.01.19 10:11 Сейчас в теме
Отличная библиотека, спасибо!
А имеет большой смысл привязываться к 8.3.10? Да, работа с потоками эффективна с т.зр. расходования памяти, но если убрать потоки можно расширить количество конфигураций, на которых библиотеку можно применять.
8. json 2064 31.01.19 10:32 Сейчас в теме
(7) присоединяюсь к вопросу.
Можно ли будет использовать для более старых конфигураций?
УПП, например очень часто встречается: версия платформы 8.3.10 и выше, но режим совместимости 8.2.13
16. bonv 647 31.01.19 13:56 Сейчас в теме
(7)(8) Ну дело не только в потоках. В принципе портировать на 8.2 можно
45. leemuar 18.02.19 16:21 Сейчас в теме
(16) когда ждать порт? Или куда приcылать pull request? Или лучше сделать свой форк?
47. bonv 647 19.02.19 11:49 Сейчас в теме
(45) Лучше свой форк, т.к. реализации будут не совместимы из-за функций работы со строками
48. leemuar 19.02.19 11:54 Сейчас в теме
(47) в чем именно будет несовместимость? Быстрый анализ кода не выявил каких-то сложностей с заменой встроенных функций работы со строками на самописные. Что я проглядел?
49. bonv 647 19.02.19 11:59 Сейчас в теме
(48) СтрНайти и Найти
То что сейчас работает Найти, это не значит, что она будет работать в следующей версии платформы
9. tsukanov 69 31.01.19 10:38 Сейчас в теме
Годнота пошла в топе. Неужели темные времена на инфостарте закончились )
sigmov; TreeDogNight; DrAku1a; Alien_job; rpgshnik; zeegin; Labotamy; CyberCerber; SerVer1C; Soloist; the1; +11 Ответить
10. kuntashov 366 31.01.19 10:43 Сейчас в теме
Очень круто (и почему раньше никто не реализовал?!), даешь порт для OScript!
Labotamy; +1 Ответить
11. comol 3804 31.01.19 11:34 Сейчас в теме
Однозначный плюс - спасибо
13. spy-83 185 31.01.19 12:51 Сейчас в теме
14. saa@kuzov.org 31.01.19 13:45 Сейчас в теме
Спасибо!
Очень вовремя, а то писал какие-то свои реализации частных случаев.

Подскажите, может есть на Python библиотека для "другой стороны"? Я, в основном, на 1С делаю http-сервисы, так же была идея как-то унифицировать обработку входящих запросов, возврат значений и ошибок, webhook'и, подписки.
15. bonv 647 31.01.19 13:53 Сейчас в теме
(14)
Подскажите, может есть на Python библиотека для "другой стороны"?

Их там много. В самом python более богатые средства работы с HTTP, чем в 1С.

Самый простой Bottle

https://aiohttp.readthedocs.io/
https://www.tornadoweb.org/
http://flask.pocoo.org/
https://bottlepy.org
https://www.djangoproject.com/
IgorArhangel; saa@kuzov.org; JohnyDeath; Il; +4 Ответить
17. MCV 31.01.19 14:10 Сейчас в теме
19. Labotamy 31.01.19 16:38 Сейчас в теме
22. JohnyDeath 291 01.02.19 08:51 Сейчас в теме
Крутой наборчик, спасибо!

Вопрос: а нет ли библиотеки, которая разбирает фильтры OData в какой-нибудь удобный вид?
Надо делать хттп-сервис в 1с, который бы поддерживал базовые фильтры в стиле OData. Наверняка это уже где-то сделано.
TreeDogNight; +1 Ответить
23. AlexeyDmuhin 01.02.19 09:35 Сейчас в теме
Отличная работа! Спасибо!
24. rwn_driver 7 01.02.19 15:42 Сейчас в теме
25. Fannasankh 16 02.02.19 12:51 Сейчас в теме
Отличная штука. Ещё бы бьютифул суп сделать для 1с
26. Fannasankh 16 03.02.19 13:11 Сейчас в теме
При переборе куков нужно добавить проверку на то, что есть не только ключ, но значение, а то крашится.
27. bonv 647 03.02.19 13:25 Сейчас в теме
28. Fannasankh 16 03.02.19 16:46 Сейчас в теме
29. bonv 647 03.02.19 18:00 Сейчас в теме
30. MCV 04.02.19 16:11 Сейчас в теме
Сам python нужен для работы библиотеки?
31. bonv 647 04.02.19 16:42 Сейчас в теме
32. 7OH 32 07.02.19 14:17 Сейчас в теме
{ОбщийМодуль.КоннекторHTTP.Модуль(1502)}: Ошибка при вызове метода контекста (ПрочитатьJSON)
Объект = ПрочитатьJSON(
по причине:
Непредвиденный символ при чтении JSON

А вот , что выдаёт в ответе PostMan

{
    "Успех": true,
    "ФИО": {
        "Фамилия": "Пупкин",
        "Имя": "Африкан",
        "Отчество": "Свиридович"
    },
    "ДР": "2013-03-18T09:53:27",
    "Дети": [
        "Вася",
        "Лена"
    ]
}
Показать


А вот код, собирающий ответ
Кодировка = "UTF-8";

ЗаписьJSON = Новый ЗаписьJSON();

ПараметрыЗаписи = Новый ПараметрыЗаписиJSON(, Символы.Таб);

ЗаписьJSON.УстановитьСтроку(ПараметрыЗаписи);

ЗаписатьJSON(ЗаписьJSON, Данные);
СтрокаJSON = ЗаписьJSON.Закрыть();

Ответ = Новый HTTPСервисОтвет(200);

Ответ.УстановитьТелоИзСтроки(СтрокаJSON, Кодировка, ИспользованиеByteOrderMark.НеИспользовать);

Возврат Ответ;
Показать


Что не так ?
33. bonv 647 07.02.19 15:07 Сейчас в теме
(32) Нужно попробовать сделать так:
Ответ = КоннекторHTTP.Get("......");
Сообщить(Ответ.КодСостояния);
Сообщить(КоннекторHTTP.КакТекст(Ответ));


Скорей всего по какой-то причин ответ пришел не в формате JSON
34. 7OH 32 07.02.19 15:29 Сейчас в теме
(33)
ообщить(Ответ.КодСостояния); Сообщить(КоннекторHTTP.КакТекст(Ответ));

Спасибо.
Полдела есть "<title>IIS 10.0 Detailed Error - 401.5 - Unauthorized</title> "

Вот код

Аутентификация = Новый Структура("Пользователь, Пароль", "1cuser", "1cparol");

Ответ = КоннекторHTTP.Get("http://111.222.333.444/base/hs/service/Test", Новый Структура("Аутентификация", Аутентификация));

Сообщить(Ответ.КодСостояния);


Вызов же вроде верный.
35. bonv 647 07.02.19 15:32 Сейчас в теме
(34) В публикации сервиса в IIS используется анонимная аутентификация?
36. 7OH 32 07.02.19 15:35 Сейчас в теме
(33)Ещё раз спасибо. Одной запятой перед параметрами не хватило.
Не рассмотрел в примере из шапки 2 запятые в конце.
41. MCV 10.02.19 09:34 Сейчас в теме
(33) На том же попался, что при отправке POST ошибка на непредвиденный символ
Только у меня GET возвращает корректные данные.

в описании API
....
Client : Работа с клиентами Show/Hide List Operations Expand Operations
GET /client Получение списка клиентов
POST /client Создание клиента
GET /client/{id} Получение клиент по ID
PUT /client/{id} Обновление клиента по ID


Но ошибка явно кроется в том, что отвечает сервер об ошибке.
В отладчике:
Ответ.КодСостояния = 500
Ответ.Тело= 43 44 62 43 6F 6D ... ДвоичныеДанные
В теле ответа есть двоичные данные. Очевидно там сервер пишет о своей проблеме в виде строки.


Я бы поправил

Объект = ПрочитатьJSON(...)


через попытку.

Если вышло исключение , то вернуть тело как строку (затолкнув ее в структуру для совместимости типов возвращаемых значений этой функции).


Проще говоря: не всегда на /POST приходит ответ в том, в чем отправили))
42. bonv 647 10.02.19 15:01 Сейчас в теме
(41) Текст ошибки можно посмотреть если вызвать КакТекст.

Вообще, безопасный алгоритм такой:
Ответ = КоннецкторHTTP.Post();
Если Ответ.КодСостояния = 200 Тогда // Зависит от сервиса, где-то и на ошибки возвращать будут JSON
    Результат = КоннекторHTTP.КакJson(Ответ);
Иначе
    ВызватьИсключение(КоннекторHTTP.КакТекст(Ответ));
КонецЕсли;
43. MCV 10.02.19 20:41 Сейчас в теме
(42)
Текст ошибки можно посмотреть если вызвать КакТекст.

Именно так.

Я не совсем понятно описал суть:

Результат =КоннекторHTTP.PostJson("http://demo1.aut............./call",Содержимое,Новый Структура("Аутентификация", ПараметрыЗапроса));
Если Результат.Получить("success") Тогда
.....
....

Иначе
Для Каждого ЗаписьОтвета Из Результат.Получить("errors") Цикл
.......
.......


PostJson не всегда возвращает ожидаемый результат.
Бывают ситуации, когда сервер вернет не 200, а кодСостояния =500 (да много их там), то тело будет содержать в себе не Json, а текст (или xml).

Ошибка возникает именно в строке 1502 , как писали в (32)
44. MCV 10.02.19 20:49 Сейчас в теме
(42) Я не совсем понятно выразился.

Использую

Результат =КоннекторHTTP.PostJson("http://demo1.auXXXXXXX",Содержимое,Новый Структура("Аутентификация", ПараметрыЗапроса));
	Если Результат.Получить("success") Тогда 
	...	
	Иначе 
		Для Каждого ЗаписьОтвета Из Результат.Получить("errors") Цикл
...


Не всегда ответ содержит именно Json. И ошибка в модуле коннектора стр. 1503 как писали в (32).
Я в (41) предложил)
40. MCV 09.02.19 13:55 Сейчас в теме
37. leobrn 157 08.02.19 12:38 Сейчас в теме
подскажите, как задать параметр ассоциативный массив? (sort[updated_at]=3)

http://direct.ru/lead/25/list?sort[updated_at]=3

Пробовал так:

П
араметрыЗапроса = Новый Структура;

	СтруктураСортировка = Новый Соответствие;
	СтруктураСортировка .Вставить("updated_at ",3);
	
	ПараметрыЗапроса.Вставить("sort", СтруктураСортировка );
38. bonv 647 08.02.19 13:03 Сейчас в теме
(37)

Поправил ошибку.
Должно работать так:

ПараметрыЗапроса = Новый Соответствие;
ПараметрыЗапроса.Вставить("sort[updated_at]", "3");
	
Ответ = КоннекторHTTP.Get("http://direct.ru/lead/25/list", ПараметрыЗапроса);
39. leobrn 157 08.02.19 13:16 Сейчас в теме
(38)
sort[updated_at]


взлетело, спасибо
46. bonv 647 18.02.19 19:56 Сейчас в теме
UPDATE: Доступна версия для 1Script
opm install 1connector
Merc; GreenDragon; +2 Ответить
50. GreenDragon 19.02.19 16:31 Сейчас в теме
(46) Даже библиотеку запилил? Просто огонь! Моё увОжение...
52. leemuar 19.02.19 18:17 Сейчас в теме
Оставьте свое сообщение