Изменения документа Протокол интеграции систем внешних наливов с Топаз "Web Офис"

Сводка

• Свойства страницы (2 изменено, 0 добавлено, 0 удалено)

Подробности

Свойства страницы

Родительский документ

...	...	@@ -1,1 +1,1 @@
1		-vneshnie_api.vneshnie_nalivy2.WebHome
	1	+Main.WebHome

Содержимое

...	...	@@ -1,3 +1,5 @@
	1	+{{toc/}}
	2	+
1	1	v 1.0.1
2	2
3	3	== Настройка перед интеграцией ==
...	...	@@ -11,7 +11,6 @@
11	11	1. Список ip адресов, с которых будут приходить запросы от боевого окружения системы внешнего налива
12	12	1. Официальное название системы внешних наливов, которое будет указано в Топаз "Web Офис"
13	13	1. Иконку системы внешних наливов в формате svg с соотношением сторон 1:1
14		-1. Email, на который будет зарегистрирован личный кабинет интегратора
15	15
16	16	После получения информации по указанным пунктам, от ООО "Топаз-сервис" будет предоставлен тестовый доступ для настройки интеграции.
17	17
...	...	@@ -19,11 +19,8 @@
19	19
20	20	(% class="box errormessage" %)
21	21	(((
22		-(% class="wikigeneratedid" id="H41443043D43D44B43943A43B44E44743D43543E43144543E43443843C43E43144343443544243F43544043543443043243044244C43243E43244143544543743043F44043E44143044543E44243243D43544843D43543944143844144243543C44B4322242243E43F430437-WebOffice2243243743043343E43B43E43243A43528header29externalSystemApikey" %)
23		-(((
24	24	=== **Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey** ===
25	25	)))
26		-)))
27	27
28	28	== ApiKey ==
29	29
...	...	@@ -35,7 +35,6 @@
35	35
36	36	Базовым адресом **(baseUrl)** для выполнения запросов является [[https:~~/~~/topazoffice.ru/ms/external-fueling/integration>>https://topazoffice.ru/ms/external-fueling/integration]]
37	37
38		-----
39	39
40	40	== **Методы API "Топаз-Web Office":** ==
41	41
...	...	@@ -55,25 +55,25 @@
55	55	{{code language="javascript" layout="LINENUMBERS"}}
56	56	{
57	57	// идентификатор станции АЗС
58		-string id
	55	+string Id
59	59	// статус станции: true – доступна, false – выключена
60		-bool enable,
	57	+bool Enable,
61	61	// наименование станции
62		-string name,
	59	+string Name,
63	63	// адрес станции
64		-string address,
	61	+string Address,
65	65	// гео точка на карте
66		-location location
	63	+location Location
67	67	{
68		-double lat,
69		-double lon },
	65	+double Lat,
	66	+double Lon },
70	70	// словарь доступных ТРК
71		-Dictionary columns {
	68	+Dictionary Columns {
72	72	// номер колонки
73	73	(int32) Key:
74	74	{
75	75	// список доступных типов топлива
76		-"fuels": [ "a92", "a95", "diesel_premium", ... N ]
	73	+"Fuels": [ "a92", "a95", "diesel_premium", ... N ]
77	77	}
78	78	} ... N
79	79	}
...	...	@@ -81,8 +81,7 @@
81	81
82	82	**Возможные идентификаторы топлива**
83	83
84		-(% border="1" %)
85		-|(% style="background-color:#e5e4e2; border-color:black" %)ID|(% style="background-color:#e5e4e2; border-color:black" %)Марка
	81	+|ID|Марка
86	86	|diesel|дизель
87	87	|diesel_premium|брендированный дизель
88	88	|a80|бензин марки А80
...	...	@@ -97,8 +97,6 @@
97	97	|propane|газ пропан
98	98	|metan|метан
99	99
100		-== ==
101		-
102	102	== Получение прайс-листа ==
103	103
104	104	Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
...	...	@@ -109,36 +109,34 @@
109	109	{
110	110	{
111	111	// идентификатор станции внутри Топаз "Web Офис"
112		- string stationId,
	106	+ string StationId,
113	113	// идентификатор топлива
114		- string productId,
	108	+ string ProductId,
115	115	// цена за 1 литр
116		- double price
117		- // Внешний код топлива
118		- string fuelExtendedId
	110	+ double Price
119	119	},
120	120	…. N
121	121	}
122	122	{{/code}}
123	123
	116	+
124	124	**Пример ответа**{{{}}}
125	125
126	126	{{code language="javascript"}}
127	127	{
128		-{"stationId": "0001", "productId": "a92", "price": 38.66, "fuelExtendedId": "92"},
129		-{"stationId": "0001", "productId": "a95_premium", "price": 45.21, "fuelExtendedId": "95"},
130		-{"stationId": "0002", "productId": "a92", "price": 38.98, , "fuelExtendedId": "92"},
	121	+{"StationId": "0001", "ProductId": "a92", "Price": 38.66},
	122	+{"StationId": "0001", "ProductId": "a95_premium", "Price": 45.21},
	123	+{"StationId": "0002", "ProductId": "a92", "Price": 38.98},
131	131	}
132	132	{{/code}}
133	133
134		-== ==
135		-
136	136	== Получение и обработка заказа ==
137	137
138		-[[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2||data-xwiki-image-style-border="true"]]
	129	+[[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2]]
139	139
140	140	Информирование "Топаз-Web Office" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
141	141
	133	+
142	142	**Тело запроса содержит JSON вида Order{{{}}}**
143	143
144	144	{{code language="javascript" layout="LINENUMBERS"}}
...	...	@@ -242,10 +242,8 @@
242	242
243	243	**200 ОК **– станция и ТРК готова принять и обработать заказ
244	244
245		-**400 **– станция или ТРК не найдена (неверный идентификатор станции или ТРК)
	237	+**400 **– станция или ТРК не найдена (не верный идентификатор станции или ТРК) **404 **– ТРК занята / ТРК не готова принять заказ
246	246
247		-**404 **– ТРК занята / ТРК не готова принять заказ
248		-
249	249	любой ответ не **200 ОК **– интерпретируется как на станции нет интернета / станция не доступна
250	250
251	251	----
...	...	@@ -278,8 +278,6 @@
278	278
279	279	все параметры являются обязательными
280	280
281		-=== ===
282		-
283	283	=== **Статус Fueling** ===
284	284
285	285	Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
...	...	@@ -296,8 +296,6 @@
296	296
297	297	все параметры являются обязательными
298	298
299		-=== ===
300		-
301	301	=== **Статус Canceled** ===
302	302
303	303	Данный статус сообщает внешней системе о том, что заказ следует отменить
...	...	@@ -312,8 +312,6 @@
312	312
313	313	**reason – **текстовая причина отмены
314	314
315		-=== ===
316		-
317	317	=== **Статус Completed** ===
318	318
319	319	Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
...	...	@@ -330,8 +330,6 @@
330	330
331	331	**extendedDate **– дата по которой АСУ строит отчет для сверки, формат **dd.MM.yyyy HH:mm:ss**
332	332
333		-=== ===
334		-
335	335	=== **Отправка счетчика налива** ===
336	336
337	337	В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива