Протокол обмена с сайтом

Данный открытый протокол разработан компаниями «1С» и «1С-Битрикс».

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

Функционально обмен делится на два блока:

выгрузка на сайт торговых предложений (каталогов продукции), данных об остатках на складах (с разбивкой и сводно), данных только о ценах и остатках (без описания номенклатуры);
обмен информацией о заказах.

Первый блок обеспечивает публикацию на сайте каталога номенклатурных позиций и данных. Второй блок необходим для передачи с сайта в систему «1С: Предприятие» информации о заказах интернет-магазина, и дальнейшую синхронизацию статусов и параметров заказов.

В обоих случаях инициатором обмена выступает система «1С: Предприятие». Обмен электронными документами осуществляется в соответствии с правилами и форматами, описанными в стандарте CommerceML 2.

При инициализации взаимодействия устанавливается HTTP соединение. Система «1С: Предприятие» запрашивает у сайта необходимые параметры, такие, как максимальный объем пакета, поддержка сжатия и др. На основании этих данных система 1С: Предприятие формирует XML сообщения и передает их на сайт.

Выгрузка на сайт

Данные для публикации на сайте выгружаются одним пакетом.

A. Начало сеанса

Выгрузка данных начинается с того, что система «1С: Предприятие» отправляет http-запрос следующего вида:
http://<сайт>/<путь> /1c_exchange.php? type=catalog& mode=checkauth.

В ответ система управления сайтом передает системе «1С: Предприятие» три строки (используется разделитель строк «\n»):

слово «success»;
имя Cookie;
значение Cookie.

Примечание. Все последующие запросы к системе управления сайтом со стороны «1С: Предприятия» содержат в заголовке запроса имя и значение Cookie.

B. Запрос параметров от сайта

Далее следует запрос следующего вида:
http://<сайт>/<путь> /1c_exchange.php? type=catalog& mode=init

В ответ система управления сайтом передает две строки:

zip=yes, если сервер поддерживает обмен в zip-формате — в этом случае на следующем шаге файлы должны быть упакованы в zip-формате
или
zip=no — в этом случае на следующем шаге файлы не упаковываются и передаются каждый по отдельности.
file_limit=<число>, где <число> — максимально допустимый размер файла в байтах для передачи за один запрос. Если системе «1С: Предприятие» понадобится передать файл большего размера, его следует разделить на фрагменты.

C. Выгрузка на сайт файлов обмена

Затем «1С: Предприятие» запросами с параметрами вида
http://<сайт>/<путь> /1c_exchange.php? type=catalog& mode=file& filename=<имя файла>
выгружает на сайт файлы обмена в формате CommerceML 2, посылая содержимое файла или его части в виде POST.

В случае успешной записи файла система управления сайтом выдает строку «success».

D. Пошаговая загрузка данных

На последнем шаге по запросу из «1С: Предприятия» производится пошаговая загрузка данных по запросу с параметрами вида http://<сайт>/<путь> /1c_exchange.php? type=catalog& mode=import& filename=<имя файла>

Во время загрузки система управления сайтом может отвечать в одном из следующих вариантов.

Если в первой строке содержится слово «progress» — это означает необходимость послать тот же запрос еще раз. В этом случае во второй строке будет возвращен текущий статус обработки, объем загруженных данных, статус импорта и т. д.
Если в ответ передается строка со словом «success», то это будет означать сообщение об успешном окончании обработки файла.

Примечание. Если в ходе какого-либо запроса произошла ошибка, то в первой строке ответа системы управления сайтом будет содержаться слово «failure», а в следующих строках — описание ошибки, произошедшей в процессе обработки запроса. Если произошла необрабатываемая ошибка уровня ядра продукта или sql-запроса, то будет возвращен html-код.

Примеры файлов выгрузки

Сведения о товарах в формате XML.

   <КоммерческаяИнформация ВерсияСхемы="2.03" ДатаФормирования="2008-03-28">
					<Документ>
				<Ид>20
				<Номер>20
				<Дата>2007-10-16
				<ХозОперация>Заказ товара
				<Роль>Продавец
				<Валюта>RUB
				<Курс>1
				<Сумма>9683.42
				<Контрагенты>
					<Контрагент>
						<Ид>1#admin#Петров Петр 
						<Наименование>Петр Петров
						<Роль>Покупатель
														<ПолноеНаименование>Петр Петров
								<Фамилия>Петров<Имя>Петр								<АдресРегистрации>
									<Представление>87698<АдресноеПоле>
										<Тип>Почтовый индекс
										<Значение>6546
									<АдресноеПоле>
										<Тип>Улица
										<Значение>87698
																	
														<Контакты>
															
														<Представители>
								<Представитель>
									<Контрагент>
										<Отношение>Контактное лицо
										<Ид>ab7399a8aa62c20e0e9f3ea53c6dac81
										<Наименование>Петр Петров
									
								
							
													
					
				
				
				<Время>15:40:40
				<Комментарий>
												<Товары>                              
									<Товар>
						<Ид>ORDER_DELIVERY
						<Наименование>Доставка заказа
						<БазоваяЕдиница Код="796" НаименованиеПолное="Штука" МеждународноеСокращение="PCE">шт
						<ЦенаЗаЕдиницу>348.00
						<Количество>1
						<Сумма>348.00
						<ЗначенияРеквизитов>
							<ЗначениеРеквизита>
								<Наименование>ВидНоменклатуры
								<Значение>Услуга
							
							<ЗначениеРеквизита>
								<Наименование>ТипНоменклатуры
								<Значение>Услуга
							
						
					
										<Товар>
						<Ид>cbcf498f-55bc-11d9-848a-00112f43529a
						<ИдКаталога>bd72d8f9-55bc-11d9-848a-00112f43529a
						<Наименование>Комбайн MOULINEX  A77 4C
						<БазоваяЕдиница Код="796" НаименованиеПолное="Штука" МеждународноеСокращение="PCE">шт
												<ЦенаЗаЕдиницу>9335.42
						<Количество>1.00
						<Сумма>9335.42
												<ЗначенияРеквизитов>
							<ЗначениеРеквизита>
								<Наименование>ВидНоменклатуры
								<Значение>Товар
							
							<ЗначениеРеквизита>
								<Наименование>ТипНоменклатуры
								<Значение>Товар
							
						
					
									
				<ЗначенияРеквизитов>
											<ЗначениеРеквизита>
							<Наименование>Дата оплаты
							<Значение>2007-10-16 15:44:47
						
												<ЗначениеРеквизита>
							<Наименование>Номер платежного документа
							<Значение>ТК000000026
						
												<ЗначениеРеквизита>
							<Наименование>Метод оплаты
							<Значение>Наличный расчет
						
												<ЗначениеРеквизита>
							<Наименование>Дата разрешения доставки
							<Значение>2007-10-16 15:51:27
						
											<ЗначениеРеквизита>
						<Наименование>Заказ оплачен
						<Значение>true
					
					<ЗначениеРеквизита>
						<Наименование>Доставка разрешена
						<Значение>true
					
					<ЗначениеРеквизита>
						<Наименование>Отменен
						<Значение>false
					
					<ЗначениеРеквизита>
						<Наименование>Финальный статус
						<Значение>true
					
					<ЗначениеРеквизита>
						<Наименование>Статус заказа
						<Значение>[F] Доставлен
					
											<ЗначениеРеквизита>
							<Наименование>Дата изменения статуса
							<Значение>2007-10-16 15:51:58

Обмен информацией о заказах

Заказы, оформленные на сайте, загружаются в систему «1С: Предприятие».

Последовательность действий при работе с заказом:

Заказ оформляется на сайте
При передаче в систему «1С: Предприятие» в заказе устанавливается категория «Заказ с сайта».
При формировании заказа в системе «1С: Предприятие» записываются номер и дата заказа, с которыми он оформлен на сайте. Поиск контрагента осуществляется по ИНН или наименованию, в зависимости от указанных настроек.
При загрузке заказа производится поиск договора с контрагентом. Договор ищется среди существующих договоров с клиентом, с признаком ведения взаиморасчетов по заказам (по указанной в настройках загрузки Организации). Если не находится ни один договор, то создается новый.
При загрузке заказа загружаются все его свойства, переданные с сайта. Свойства ищутся в системе «1С: Предприятие» по наименованию. Если с таким наименованием свойства нет, то заводится новое свойство со значениями типа строка или число.
Заказ может модифицироваться в системе «1С: Предприятие», при этом его изменения будут выгружаться на сайт
Если заказ оплачивается или отгружается в системе «1С: Предприятие», то состояния заказа по оплате и по отгрузке выгружаются на сайт только при полном выполнении операции (полной оплате и полной отгрузке). До этого момента заказ считается не оплаченным и не отгруженным.
При попытке в системе «1С: Предприятие» изменить заказ, по которому произведена оплата или отгрузка, заказ на сайт не загрузится как измененный. При этом пользователь получит об этом сообщение.
После каждой выгрузка заказа на сайт, на стороне сайта определяются значения его категорий (ссылка на категории). Эти значения устанавливаются в системе «1С: Предприятие» так, как они присвоены заказу на сайте

A. Начало сеанса

Выгрузка данных начинается с того, что система «1С: Предприятие» отправляет http-запрос следующего вида:
http://<сайт>/<путь> /1c_exchange.php? type=sale& mode=checkauth.

слово «success»;
имя Cookie;
значение Cookie.

B. Уточнение параметров сеанса

Далее следует запрос следующего вида:
http://<сайт>/<путь> /1c_exchange.php? type=sale& mode=init

В ответ система управления сайтом передает две строки:

zip=yes, если сервер поддерживает обмен в zip-формате — в этом случае на следующем шаге файлы должны быть упакованы в zip-формате
или
zip=no — в этом случае на следующем шаге файлы не упаковываются и передаются каждый по отдельности.
file_limit=<число>, где <число> — максимально допустимый размер файла в байтах для передачи за один запрос. Если системе «1С: Предприятие» понадобится передать файл большего размера, его следует разделить на фрагменты.

C. Получение файла обмена с сайта

Затем на сайт отправляется запрос вида
http://<сайт>/<путь> /1c_exchange.php? type=sale& mode=query.

Сайт передает сведения о заказах в формате CommerceML 2. В случае успешного получения и записи заказов «1С: Предприятие» передает на сайт запрос вида
http://<сайт>/<путь> /1c_exchange.php? type=sale& mode=success

D. Отправка файла обмена на сайт

Затем система «1С: Предприятие» отправляет на сайт запрос вида
http://<сайт>/<путь> /1c_exchange.php? type=sale& mode=file& filename=<имя файла>,
который загружает на сервер файл обмена, посылая содержимое файла в виде POST.

В случае успешной записи файла система управления сайтом передает строку со словом «success». Дополнительно на следующих строчках могут содержаться замечания по загрузке.

Примечание. Если в ходе какого-либо запроса произошла ошибка, то в первой строке ответа системы управления сайтом будет содержаться слово «failure», а в следующих строках — описание ошибки, произошедшей в процессе обработки запроса.
Если произошла необрабатываемая ошибка уровня ядра продукта или sql-запроса, то будет возвращен html-код.

Примеры файлов обмена информацией

Заказ на сайт в формате XML

                <КоммерческаяИнформация ВерсияСхемы="2.03" ДатаФормирования="2008-03-28">
					<Документ>
				<Ид>20
				<Номер>20
				<Дата>2007-10-16
				<ХозОперация>Заказ товара
				<Роль>Продавец
				<Валюта>RUB
				<Курс>1
				<Сумма>9683.42
				<Контрагенты>
					<Контрагент>
						<Ид>1#admin#Петров Петр 
						<Наименование>Петр Петров
						<Роль>Покупатель
														<ПолноеНаименование>Петр Петров
								<Фамилия>Петров<Имя>Петр								<АдресРегистрации>
									<Представление>87698<АдресноеПоле>
										<Тип>Почтовый индекс
										<Значение>6546
									<АдресноеПоле>
										<Тип>Улица
										<Значение>87698
																	
														<Контакты>
															
														<Представители>
								<Представитель>
									<Контрагент>
										<Отношение>Контактное лицо
										<Ид>ab7399a8aa62c20e0e9f3ea53c6dac81
										<Наименование>Петр Петров
									
								
							
													
					
				
				
				<Время>15:40:40
				<Комментарий>
												<Товары>                              
									<Товар>
						<Ид>ORDER_DELIVERY
						<Наименование>Доставка заказа
						<БазоваяЕдиница Код="796" НаименованиеПолное="Штука" МеждународноеСокращение="PCE">шт
						<ЦенаЗаЕдиницу>348.00
						<Количество>1
						<Сумма>348.00
						<ЗначенияРеквизитов>
							<ЗначениеРеквизита>
								<Наименование>ВидНоменклатуры
								<Значение>Услуга
							
							<ЗначениеРеквизита>
								<Наименование>ТипНоменклатуры
								<Значение>Услуга
							
						
					
										<Товар>
						<Ид>cbcf498f-55bc-11d9-848a-00112f43529a
						<ИдКаталога>bd72d8f9-55bc-11d9-848a-00112f43529a
						<Наименование>Комбайн MOULINEX  A77 4C
						<БазоваяЕдиница Код="796" НаименованиеПолное="Штука" МеждународноеСокращение="PCE">шт
												<ЦенаЗаЕдиницу>9335.42
						<Количество>1.00
						<Сумма>9335.42
												<ЗначенияРеквизитов>
							<ЗначениеРеквизита>
								<Наименование>ВидНоменклатуры
								<Значение>Товар
							
							<ЗначениеРеквизита>
								<Наименование>ТипНоменклатуры
								<Значение>Товар
							
						
					
									
				<ЗначенияРеквизитов>
											<ЗначениеРеквизита>
							<Наименование>Дата оплаты
							<Значение>2007-10-16 15:44:47
						
												<ЗначениеРеквизита>
							<Наименование>Номер платежного документа
							<Значение>ТК000000026
						
												<ЗначениеРеквизита>
							<Наименование>Метод оплаты
							<Значение>Наличный расчет
						
												<ЗначениеРеквизита>
							<Наименование>Дата разрешения доставки
							<Значение>2007-10-16 15:51:27
						
											<ЗначениеРеквизита>
						<Наименование>Заказ оплачен
						<Значение>true
					
					<ЗначениеРеквизита>
						<Наименование>Доставка разрешена
						<Значение>true
					
					<ЗначениеРеквизита>
						<Наименование>Отменен
						<Значение>false
					
					<ЗначениеРеквизита>
						<Наименование>Финальный статус
						<Значение>true
					
					<ЗначениеРеквизита>
						<Наименование>Статус заказа
						<Значение>[F] Доставлен
					
											<ЗначениеРеквизита>
							<Наименование>Дата изменения статуса
							<Значение>2007-10-16 15:51:58

Заказ с сайта в формате XML

   <КоммерческаяИнформация ВерсияСхемы="2.03" ДатаФормирования="2007-10-30">
	<Документ>
		<Ид>36
		<Номер>36
		<Дата>2007-10-30
		<ХозОперация>Заказ товара
		<Роль>Продавец
		<Валюта>руб
		<Курс>1
		<Сумма>6734.47
		<Контрагенты>
			<Контрагент>
				<Ид>1#admin# admin 
				<Наименование>admin
				<Роль>Покупатель
				<ПолноеНаименование>admin
				<Фамилия>Иванов
				<Имя>admin
				<АдресРегистрации>
					<Представление>ггг
					<АдресноеПоле>
						<Тип>Почтовый индекс
						<Значение>1111
					
					<АдресноеПоле>
						<Тип>Улица
						<Значение>ггг
					
				
				<Контакты/>
				<Представители>
					<Представитель>
						<Контрагент>
							<Отношение>Контактное лицо
							<Ид>b342955a9185c40132d4c1df6b30af2f
							<Наименование>admin
						
					
				
			
		
		<Время>15:19:27
		<Комментарий/>
		<Товары>
			<Товар>
				<Ид>ORDER_DELIVERY
				<Наименование>Доставка заказа
				<БазоваяЕдиница Код="796" НаименованиеПолное="Штука" МеждународноеСокращение="PCE">шт
				<ЦенаЗаЕдиницу>340.00
				<Количество>1
				<Сумма>340.00
				<ЗначенияРеквизитов>
					<ЗначениеРеквизита>
						<Наименование>ВидНоменклатуры
						<Значение>Услуга
					
					<ЗначениеРеквизита>
						<Наименование>ТипНоменклатуры
						<Значение>Услуга
					
				
			
			<Товар>
				<Ид>dee6e19a-55bc-11d9-848a-00112f43529a
				<ИдКаталога>bd72d8f9-55bc-11d9-848a-00112f43529a
				<Наименование>Телевизор "JVC"
				<БазоваяЕдиница Код="796" НаименованиеПолное="Штука" МеждународноеСокращение="PCE">шт
				<ЦенаЗаЕдиницу>6394.47
				<Количество>1.00
				<Сумма>6394.47
				<ЗначенияРеквизитов>
					<ЗначениеРеквизита>
						<Наименование>ВидНоменклатуры
						<Значение>Товар
					
					<ЗначениеРеквизита>
						<Наименование>ТипНоменклатуры
						<Значение>Товар
					
				
			
		
		<ЗначенияРеквизитов>
			<ЗначениеРеквизита>
				<Наименование>Метод оплаты
				<Значение>Наличный расчет
			
			<ЗначениеРеквизита>
				<Наименование>Заказ оплачен
				<Значение>false
			
			<ЗначениеРеквизита>
				<Наименование>Доставка разрешена
				<Значение>false
			
			<ЗначениеРеквизита>
				<Наименование>Отменен
				<Значение>false
			
			<ЗначениеРеквизита>
				<Наименование>Финальный статус
				<Значение>false
			
			<ЗначениеРеквизита>
				<Наименование>Статус заказа
				<Значение>[N] Принят
			
			<ЗначениеРеквизита>
				<Наименование>Дата изменения статуса
				<Значение>2007-10-30 15:19:27

Представленный протокол используется для интеграции системы «1С: Предприятие» с системами «1С-Битрикс: Управление сайтом», «UMI.CMS» и другими.