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

Сводка

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

Подробности

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

Содержимое

...	...	@@ -16,9 +16,13 @@
16	16
17	17	Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в Топаз "Web Офис". Данный ключ необходимо будет передавать во всех запросах от внешней системы в Топаз "Web Офис" в заголовке externalSystemApikey
18	18
	19	+== Адрес для отправки запросов ==
	20	+
	21	+Базовым адресом **(baseUrl)** для выполнения запросов является [[https:~~/~~/topazoffice.ru/ms/external-fueling/integration>>https://topazoffice.ru/ms/external-fueling/integration]]
	22	+
19	19	== Получение списка АЗС и их конфигураций ==
20	20
21		-Внешняя система опрашивает Топаз "Web Офис" для получения списка АЗС и их конфигураций **через HTTP **запрос на **url **с префиксом **/integration/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
	25	+Внешняя система опрашивает Топаз "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секунд.
	77	+Внешняя система опрашивает Топаз "Web Офис" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
74	74
75	75	В ответ Топаз "Web Офис" дает ответ в формате **JSON**{{{}}}
76	76
...	...	@@ -89,20 +89,7 @@
89	89	{{/code}}
90	90
91	91
92		-{{code language="javascript"}}
93		-{
94		-{
95		-// идентификатор станции внутри Топаз "Web Офис"
96		-string StationId,
97		-// идентификатор топлива
98		-string ProductId,
99		-// цена за 1 литр
100		-double Price
101		-}, …. N
102		-}
103		-{{/code}}
104	104
105		-
106	106	**Пример ответа**{{{}}}
107	107
108	108	{{code language="javascript"}}
...	...	@@ -117,7 +117,7 @@
117	117
118	118	[[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2]]
119	119
120		-Информирование Топаз "Web Офис" о заказе и их статусах осуществляется **HTTP **запросом на **url **с префиксом **/integration/order **, запрос типа **POST **, timeout 10 секунд.
	111	+Информирование Топаз "Web Офис" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
121	121
122	122
123	123	**Тело запроса содержит JSON вида Order**{{{}}}
...	...	@@ -195,7 +195,7 @@
195	195
196	196	В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
197	197
198		-**базовый url + /api/order/accept POST**
	189	+**baseUrl + /api/order/accept POST**
199	199
200	200	**apikey={apikey}&orderId={ordeId}**
201	201
...	...	@@ -209,7 +209,7 @@
209	209
210	210	В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
211	211
212		-**базовый url + /api/order/fueling POST**
	203	+**baseUrl + /api/order/fueling POST**
213	213
214	214	**apikey={apikey}&orderId={ordeId}**
215	215
...	...	@@ -219,7 +219,7 @@
219	219
220	220	Данный статус сообщает внешней системе о том, что заказ следует отменить
221	221
222		-**базовый url + /api/order/canceled**
	213	+**baseUrl + /api/order/canceled**
223	223
224	224	**POST**
225	225
...	...	@@ -235,7 +235,7 @@
235	235
236	236	В случае если внешняя система дала ответ отличный от **200 ОК **, то Топаз "Web Офис" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
237	237
238		-**базовый url + /api/order/completed POST**
	229	+**baseUrl + /api/order/completed POST**
239	239
240	240	**apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&**
241	241
...	...	@@ -253,7 +253,7 @@
253	253
254	254	Для этого с периодичностью от 5 – 10 секунд Топаз "Web Офис" выполняет следующий запрос
255	255
256		-**базовый url + /api/order/volume**
	247	+**baseUrl + /api/order/volume**
257	257
258	258	**POST**
259	259
...	...	@@ -265,9 +265,9 @@
265	265
266	266	== Проверка статуса работы станции ==
267	267
268		-Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ url с префиксом
	259	+Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
269	269
270		-**/integration/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
	261	+**/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
271	271
272	272	**columnId **– идентификатор ТРК
273	273