Для продажи автозапчастей в интернете уже сделано немало готовых платформ. Какие-то распространяются по ежемесячной подписке. Другие можно купить и установить на своем сервере. Платформа Docpart выгодно отличается на фоне конкурентов низкой стоимостью и необходимым функционалом для открытия своего интернет-магазина. Функционально она в чем-то уступает более именитым конкурентам, но далеко не все пользователи используют функционал интернет-магазина "по полной".  Платформа потихоньку обрастает новыми функциями и становится чуть-чуть лучше с каждым обновлением. Открытость кода позволяет дорабатывать необходимый функционал самостоятельно не "подсаживаясь" на сервисную поддержку производителя. 

Для реализации обмена я разработал небольшое API, которое позволяет оперативно получать данные с сайта и обрабатывать их в вашей учетной системе. Причем учетной системой может быть не только 1С. 

Работа с сервисом

Для использования API необходимо установить модули из архива docpart_1c_api.zip на ваш веб-сервер. Для примера, скопируем все модули в каталог /api/agent_1c.

Если Вы назовете свой каталог по-другому, то не забудьте изменить путь к вызову методов веб-сервиса во всех командах в обработке.

Работа с веб-сервисом осуществляется посредством отправки POST-запросов к входной точке веб-сервиса, которой является скрипт execute.php с передачей необходимого метода и параметров. В ответ будут возвращены необходимые данные. 

Для использования API версия платформы 1С значения не имеет. Работать будет с любой учетной системой для которой есть возможность отправки POST-запроса и обработки его результата. 

В нашем примере все запросы следует отправлять к адресу:

http://мой-магазин.рф/api/agent_1c/execute.php

Для запросов обязательна передача заголовка

content-type: application/x-www-form-urlencoded

В теле POST-запроса есть два общих для всех методов параметра:

• task – имя метода API для выполнения
• tech_key – Ключ для вызова скриптов. Его необходимо взять из панели управления платформы Docpart в разделе «Настройки».

При вызове любого метода будет возвращена JSON-структура с полями

• status – Булево – статус выполнения метода
• message – Строка – Сообщение об ошибке
• data – Результат выполнения метода

Пример вызова метода для платформы 8.3 (8.3.5+):

Процедура ВыполнитьЗапросDocpartAPI()
	
	//Изменить параметры на свои значения
	АдресСайта = "мой-магазин.рф";	
	ТелоЗапроса = "tech_key=TESTKEYTECH&task=check_connection";
	ПротоколHTTPS = Истина;
	
	//Вызов метода API
	Если ПротоколHTTPS Тогда
		ЗащищенноеСоединение = Новый ЗащищенноеСоединениеOpenSSL();
		ПодключениеКСерверу = Новый  HTTPСоединение(АдресСайта,,,,,30, ЗащищенноеСоединение);	
	Иначе		
		ПодключениеКСерверу = Новый  HTTPСоединение(АдресСайта,,,,,30);	
	КонецЕсли;
	
	ОтветСервера = Неопределено;
	Если ПодключениеКСерверу = Неопределено Тогда
		ОбщегоНазначения.СообщитьОбОшибке("Обмен с WEB-сайтом: ошибка подключения к сайту: "+ОписаниеОшибки());		
		Возврат ;
	КонецЕсли;
	
	СтрокаПодключения = "api/agent_1c/execute.php";	
	ЗаголовокHTTP = Новый Соответствие;
	ЗаголовокHTTP.Вставить("Content-Type","application/x-www-form-urlencoded; charset=UTF-8");		
	ЗапросHTTP =  Новый HTTPЗапрос(СтрокаПодключения, ЗаголовокHTTP);
	ЗапросHTTP.УстановитьТелоИзСтроки(ТелоЗапроса,КодировкаТекста.ANSI);
	Попытка
		РезультатЗапроса = ПодключениеКСерверу.ОтправитьДляОбработки(ЗапросHTTP);
		ОтветСервера	= РезультатЗапроса.ПолучитьТелоКакСтроку();	
	Исключение
		ОбщегоНазначения.СообщитьОбОшибке("Обмен с WEB-сайтом: ошибка отправки данных на сервер: "+ОписаниеОшибки());		
	КонецПопытки;
	
	Если НЕ ЗначениеЗаполнено(ОтветСервера) Тогда
		Возврат;
	КонецЕсли;
	
	//JSON ENCODE
	Чтение = Новый ЧтениеJSON;
	Чтение.УстановитьСтроку(ОтветСервера);
	Результат = ПрочитатьJSON(Чтение, Истина); //Структура запроса для дальнейшей обработки
	Чтение.Закрыть();
	
	//Обрабатываем дальнейший результат
	Если Результат["status"] Тогда
		ОбщегоНазначения.Сообщение("Связь с сайтом установлена");
	Иначе
		ОбщегоНазначения.Сообщение("Ошибка связи с сайтом: "+Результат["message"]);
	Конецесли;
	
КонецПроцедуры

Пример работы с веб-сервисом

Обработка тестировалась на платформе 8.3.5 но должна работать и на более ранних версиях. В настройках обработки необходимо прописать адрес Вашего сайта и ключ доступа. Адрес скрипта на сервере можно менять по-своему усмотрению, тогда необходимо изменить соответствующую настройку.  

Для повышения безопасности на Вашем веб-сервере можно настроить HTTP-авторизацию для доступа к каталогу с модулем API. Тогда в настройках необходимо указать логин и пароль для доступа. 

В обработке реализованы вызовы всех методов API. При появлении новых методов обработка будет обновляться. Пока сделана для конфигураций на обычных формах. В случае необходимости, добавлю для управляемых. Фильтры на форме реализованы только основные. Передача остальных фильтров выполняется добавлением в структуру необходимых полей. Имена необходимых полей можно увидеть в функции модуля "ПолучитьПараметрыМетода". 

Для вызова метода API необходимо заполнить структуру параметров и вызвать нужный метод из модуля обработки. Метод возвращает таблицу значений с данными сайта. 

    СтруктураФильтров = Новый Структура;
	Если ЗначениеЗаполнено(НачалоПериодаОплаты) Тогда
		СтруктураФильтров.Вставить("НачалоПериода", НачалоПериодаОплаты);
	КонецЕсли;
	Если ЗначениеЗаполнено(КонецПериодаОплаты) Тогда
		СтруктураФильтров.Вставить("КонецПериода", КонецПериодаОплаты);
	КонецЕсли;
	Если ЗначениеЗаполнено(КодОперации) Тогда
		СтруктураФильтров.Вставить("КодОперации", КодОперации);
    КонецЕсли;
    	
	ТаблицаОплат = ПолучитьОплатыПокупателей(СтруктураФильтров);//Вызываем метод из модуля обработки

ВНИМАНИЕ: Обработка только возвращает данные с сайта. Сохранение данных для своей конфигурации необходимо реализовывать самостоятельно! Позже планируется добавить полноценную интеграцию для типовых конфигураций. 

Методы API

Проверка соединения с сервисом

Метод используется для проверки связи с сайтом и корректности указания настроек обмена.

Операция: check_connection

Параметры запроса:

Для проверки связи с веб-сервисом предназначен метод check_connection. При успешном выполнении метод возвращает ответ:

Получение списка заказов

Метод возвращает список заказов, соответствующих отбору.

Операция: get_orders

Параметры запроса:

Результат запроса представляет собой структуру с данными:

При успешном выполнении метод возвращает данные [data]:

Получение списка позиций заказов

Метод возвращает список товаров заказов, выбранных заказов.

Операция: get_orders_items

Параметры запроса:

Результат запроса представляет собой структуру с данными:

При успешном выполнении метод возвращает данные [data]:

Получение информации о пользователе

Метод возвращает расширенную информацию о пользователе.

Операция: get_user_info

Параметры запроса:

Для проверки связи с веб-сервисом предназначен метод check_connection. При успешном выполнении метод возвращает ответ:

Структура Data содержит следующие данные

В результат запроса будут добавлены все значения регистрационных полей, определенных для текущего способа регистрации. Их состав можно определить в панели управления в разделе: Пользователи – Поля регистрации.

Получение транзакций оплаты

Метод возвращает список транзакций оплаты проведенных на сайте

Операция: get_payments

Параметры запроса:

Результат запроса представляет собой структуру с данными:

При успешном выполнении метод возвращает данные [data]:

Получение информации об артикуле

Метод возвращает список производителей и наименования товара по его артикулу. Получение данных выполняется с сервера Кроссов Docpart. Для одного артикула может быть возвращено несколько вариантов производителей.

Операция: get_article_info

Параметры запроса:

Результат запроса представляет собой структуру с данными:

При успешном выполнении метод возвращает данные [data]:

Обновления

UPD 30.04.2020: Добавлена документация по всем методам: Полная документация по методам Docpart 1C API

UPD 14.07.2019: Добавлена обработка получения данных для 1С

UPD 20.07.2019: Исправление некоторых замечаний. Изменены имена некоторых параметров и свойств. Для метода get_user_info добавлена возможность передачи массива идентификаторов пользователей. В архив с модулями добавлен файл описания методов API.

UPD 28.07.2019: Получение информации о товарах выделено в отдельный метод — get_orders_items. Добавлен метод для получения информации о товарах — get_article_info. Исправлена обработка для работы с новыми методами.