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

Сводка

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

Подробности

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

Содержимое

...	...	@@ -14,15 +14,20 @@
14	14
15	15	После получения информации по указанным пунктам, от ООО "Топаз-сервис" будет предоставлен тестовый доступ для настройки интеграции.
16	16
17		-Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в Топаз "Web Офис". Данный ключ необходимо будет передавать во всех запросах от внешней системы в Топаз "Web Офис" в заголовке externalSystemApikey
	17	+Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в Топаз "Web Офис".
18	18
	19	+(% class="box errormessage" %)
	20	+(((
	21	+Данный ключ необходимо будет передавать во всех запросах от внешней системы в Топаз "Web Офис" в заголовке externalSystemApikey
	22	+)))
	23	+
19	19	== Адрес для отправки запросов ==
20	20
21		-Базовым адресом (baseUrl) для выполнения запросов является https:~/~/topazoffice.ru/ms/external-fueling/integration
	26	+Базовым адресом **(baseUrl)** для выполнения запросов является [[https:~~/~~/topazoffice.ru/ms/external-fueling/integration>>https://topazoffice.ru/ms/external-fueling/integration]]
22	22
23	23	== Получение списка АЗС и их конфигураций ==
24	24
25		-Внешняя система опрашивает Топаз "Web Офис" для получения списка АЗС и их конфигураций **через HTTP **запрос на **url **с префиксом **/integration/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
	30	+Внешняя система опрашивает Топаз "Web Офис" для получения списка АЗС и их конфигураций **через HTTP **запрос на **baseUrl **с префиксом **/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
26	26
27	27	В ответ Топаз "Web Офис" дает ответ в формате **JSON**
28	28
...	...	@@ -74,7 +74,7 @@
74	74
75	75	== Получение прайс-листа ==
76	76
77		-Внешняя система опрашивает Топаз "Web Офис" для получения прайс-листа **HTTP **запросом на **url **с префиксом **/integration/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
	82	+Внешняя система опрашивает Топаз "Web Офис" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
78	78
79	79	В ответ Топаз "Web Офис" дает ответ в формате **JSON**{{{}}}
80	80
...	...	@@ -108,7 +108,7 @@
108	108
109	109	[[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2]]
110	110
111		-Информирование Топаз "Web Офис" о заказе и их статусах осуществляется **HTTP **запросом на **url **с префиксом **/integration/order **, запрос типа **POST **, timeout 10 секунд.
	116	+Информирование Топаз "Web Офис" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
112	112
113	113
114	114	**Тело запроса содержит JSON вида Order**{{{}}}
...	...	@@ -186,7 +186,7 @@
186	186
187	187	В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
188	188
189		-**базовый url + /api/order/accept POST**
	194	+**baseUrl + /api/order/accept POST**
190	190
191	191	**apikey={apikey}&orderId={ordeId}**
192	192
...	...	@@ -200,7 +200,7 @@
200	200
201	201	В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
202	202
203		-**базовый url + /api/order/fueling POST**
	208	+**baseUrl + /api/order/fueling POST**
204	204
205	205	**apikey={apikey}&orderId={ordeId}**
206	206
...	...	@@ -210,7 +210,7 @@
210	210
211	211	Данный статус сообщает внешней системе о том, что заказ следует отменить
212	212
213		-**базовый url + /api/order/canceled**
	218	+**baseUrl + /api/order/canceled**
214	214
215	215	**POST**
216	216
...	...	@@ -226,7 +226,7 @@
226	226
227	227	В случае если внешняя система дала ответ отличный от **200 ОК **, то Топаз "Web Офис" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
228	228
229		-**базовый url + /api/order/completed POST**
	234	+**baseUrl + /api/order/completed POST**
230	230
231	231	**apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&**
232	232
...	...	@@ -244,7 +244,7 @@
244	244
245	245	Для этого с периодичностью от 5 – 10 секунд Топаз "Web Офис" выполняет следующий запрос
246	246
247		-**базовый url + /api/order/volume**
	252	+**baseUrl + /api/order/volume**
248	248
249	249	**POST**
250	250
...	...	@@ -256,9 +256,9 @@
256	256
257	257	== Проверка статуса работы станции ==
258	258
259		-Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ url с префиксом
	264	+Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
260	260
261		-**/integration/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
	266	+**/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
262	262
263	263	**columnId **– идентификатор ТРК
264	264