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

Сводка

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

Подробности

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

Содержимое

...	...	@@ -1,4 +1,4 @@
1		-====== **v 1.0.1** ======
	1	+v 1.0.1
2	2
3	3	== Настройка перед интеграцией ==
4	4
...	...	@@ -18,8 +18,11 @@
18	18
19	19	(% class="box errormessage" %)
20	20	(((
	21	+(% class="wikigeneratedid" id="H41443043D43D44B43943A43B44E44743D43543E43144543E43443843C43E43144343443544243F43544043543443043243044244C43243E43244143544543743043F44043E44143044543E44243243D43544843D43543944143844144243543C44B4322242243E43F430437-WebOffice2243243743043343E43B43E43243A43528header29externalSystemApikey" %)
	22	+(((
21	21	=== **Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey** ===
22	22	)))
	25	+)))
23	23
24	24	== ApiKey ==
25	25
...	...	@@ -31,6 +31,7 @@
31	31
32	32	Базовым адресом **(baseUrl)** для выполнения запросов является [[https:~~/~~/topazoffice.ru/ms/external-fueling/integration>>https://topazoffice.ru/ms/external-fueling/integration]]
33	33
	37	+----
34	34
35	35	== **Методы API "Топаз-Web Office":** ==
36	36
...	...	@@ -76,7 +76,8 @@
76	76
77	77	**Возможные идентификаторы топлива**
78	78
79		-|ID|Марка
	83	+(% border="1" %)
	84	+|(% style="border-color:black" %)ID|(% style="border-color:black" %)Марка
80	80	|diesel|дизель
81	81	|diesel_premium|брендированный дизель
82	82	|a80|бензин марки А80
...	...	@@ -91,6 +91,8 @@
91	91	|propane|газ пропан
92	92	|metan|метан
93	93
	99	+== ==
	100	+
94	94	== Получение прайс-листа ==
95	95
96	96	Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
...	...	@@ -111,7 +111,6 @@
111	111	}
112	112	{{/code}}
113	113
114		-
115	115	**Пример ответа**{{{}}}
116	116
117	117	{{code language="javascript"}}
...	...	@@ -122,13 +122,14 @@
122	122	}
123	123	{{/code}}
124	124
	131	+== ==
	132	+
125	125	== Получение и обработка заказа ==
126	126
127		-[[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2]]
	135	+[[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"]]
128	128
129	129	Информирование "Топаз-Web Office" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
130	130
131		-
132	132	**Тело запроса содержит JSON вида Order{{{}}}**
133	133
134	134	{{code language="javascript" layout="LINENUMBERS"}}
...	...	@@ -216,9 +216,6 @@
216	216	**FuelId **+ **PriceFuel **– в случае если стоимость топлива в Топаз "Web Офис" отличается от присланной, то Топаз "Web Офис" дает ответ **402.**
217	217
218	218
219		-
220		-
221		-
222	222	== Проверка статуса работы станции ==
223	223
224	224	Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
...	...	@@ -235,8 +235,10 @@
235	235
236	236	**200 ОК **– станция и ТРК готова принять и обработать заказ
237	237
238		-**400 **– станция или ТРК не найдена (не верный идентификатор станции или ТРК) **404 **– ТРК занята / ТРК не готова принять заказ
	242	+**400 **– станция или ТРК не найдена (неверный идентификатор станции или ТРК)
239	239
	244	+**404 **– ТРК занята / ТРК не готова принять заказ
	245	+
240	240	любой ответ не **200 ОК **– интерпретируется как на станции нет интернета / станция не доступна
241	241
242	242	----
...	...	@@ -243,7 +243,7 @@
243	243
244	244	Для получения статусов Интегратору необходимо со своей стороны реализовать сервис для их получения и обработки.
245	245
246		-== **Методы REST API интегратора:** ==
	252	+== **Методы REST API интегратора (внешней системы):** ==
247	247
248	248	1. **Статус Accepted**
249	249	1. **Статус Fueling**
...	...	@@ -269,6 +269,8 @@
269	269
270	270	все параметры являются обязательными
271	271
	278	+=== ===
	279	+
272	272	=== **Статус Fueling** ===
273	273
274	274	Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
...	...	@@ -285,6 +285,8 @@
285	285
286	286	все параметры являются обязательными
287	287
	296	+=== ===
	297	+
288	288	=== **Статус Canceled** ===
289	289
290	290	Данный статус сообщает внешней системе о том, что заказ следует отменить
...	...	@@ -299,6 +299,8 @@
299	299
300	300	**reason – **текстовая причина отмены
301	301
	312	+=== ===
	313	+
302	302	=== **Статус Completed** ===
303	303
304	304	Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
...	...	@@ -315,6 +315,8 @@
315	315
316	316	**extendedDate **– дата по которой АСУ строит отчет для сверки, формат **dd.MM.yyyy HH:mm:ss**
317	317
	330	+=== ===
	331	+
318	318	=== **Отправка счетчика налива** ===
319	319
320	320	В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива