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

Сводка

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

Подробности

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

Содержимое

...	...	@@ -14,11 +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	+
	24	+== Адрес для отправки запросов ==
	25	+
	26	+Базовым адресом **(baseUrl)** для выполнения запросов является [[https:~~/~~/topazoffice.ru/ms/external-fueling/integration>>https://topazoffice.ru/ms/external-fueling/integration]]
	27	+
19	19	== Получение списка АЗС и их конфигураций ==
20	20
21		-Внешняя система опрашивает Топаз "Web Офис" для получения списка АЗС и их конфигураций **через HTTP **запрос на **url **с префиксом **/integration/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
	30	+Внешняя система опрашивает Топаз "Web Офис" для получения списка АЗС и их конфигураций **через HTTP **запрос на **baseUrl **с префиксом **/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
22	22
23	23	В ответ Топаз "Web Офис" дает ответ в формате **JSON**
24	24
...	...	@@ -70,7 +70,7 @@
70	70
71	71	== Получение прайс-листа ==
72	72
73		-Внешняя система опрашивает Топаз "Web Офис" для получения прайс-листа **HTTP **запросом на **url **с префиксом **/integration/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
	82	+Внешняя система опрашивает Топаз "Web Офис" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
74	74
75	75	В ответ Топаз "Web Офис" дает ответ в формате **JSON**{{{}}}
76	76
...	...	@@ -104,7 +104,7 @@
104	104
105	105	[[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2]]
106	106
107		-Информирование Топаз "Web Офис" о заказе и их статусах осуществляется **HTTP **запросом на **url **с префиксом **/integration/order **, запрос типа **POST **, timeout 10 секунд.
	116	+Информирование Топаз "Web Офис" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
108	108
109	109
110	110	**Тело запроса содержит JSON вида Order**{{{}}}
...	...	@@ -182,7 +182,7 @@
182	182
183	183	В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
184	184
185		-**базовый url + /api/order/accept POST**
	194	+**baseUrl + /api/order/accept POST**
186	186
187	187	**apikey={apikey}&orderId={ordeId}**
188	188
...	...	@@ -196,7 +196,7 @@
196	196
197	197	В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
198	198
199		-**базовый url + /api/order/fueling POST**
	208	+**baseUrl + /api/order/fueling POST**
200	200
201	201	**apikey={apikey}&orderId={ordeId}**
202	202
...	...	@@ -206,7 +206,7 @@
206	206
207	207	Данный статус сообщает внешней системе о том, что заказ следует отменить
208	208
209		-**базовый url + /api/order/canceled**
	218	+**baseUrl + /api/order/canceled**
210	210
211	211	**POST**
212	212
...	...	@@ -222,7 +222,7 @@
222	222
223	223	В случае если внешняя система дала ответ отличный от **200 ОК **, то Топаз "Web Офис" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
224	224
225		-**базовый url + /api/order/completed POST**
	234	+**baseUrl + /api/order/completed POST**
226	226
227	227	**apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&**
228	228
...	...	@@ -240,7 +240,7 @@
240	240
241	241	Для этого с периодичностью от 5 – 10 секунд Топаз "Web Офис" выполняет следующий запрос
242	242
243		-**базовый url + /api/order/volume**
	252	+**baseUrl + /api/order/volume**
244	244
245	245	**POST**
246	246
...	...	@@ -252,9 +252,9 @@
252	252
253	253	== Проверка статуса работы станции ==
254	254
255		-Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ url с префиксом
	264	+Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
256	256
257		-**/integration/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
	266	+**/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
258	258
259	259	**columnId **– идентификатор ТРК
260	260