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

Сводка

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

Подробности

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

Содержимое

...	...	@@ -14,20 +14,11 @@
14	14
15	15	После получения информации по указанным пунктам, от ООО "Топаз-сервис" будет предоставлен тестовый доступ для настройки интеграции.
16	16
17		-Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в Топаз "Web Офис".
	17	+Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в Топаз "Web Офис". Данный ключ необходимо будет передавать во всех запросах от внешней системы в Топаз "Web Офис" в заголовке externalSystemApikey
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		-
28	28	== Получение списка АЗС и их конфигураций ==
29	29
30		-Внешняя система опрашивает Топаз "Web Офис" для получения списка АЗС и их конфигураций **через HTTP **запрос на **baseUrl **с префиксом **/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
	21	+Внешняя система опрашивает Топаз "Web Офис" для получения списка АЗС и их конфигураций **через HTTP **запрос на **url **с префиксом **/integration/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
31	31
32	32	В ответ Топаз "Web Офис" дает ответ в формате **JSON**
33	33
...	...	@@ -79,7 +79,7 @@
79	79
80	80	== Получение прайс-листа ==
81	81
82		-Внешняя система опрашивает Топаз "Web Офис" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
	73	+Внешняя система опрашивает Топаз "Web Офис" для получения прайс-листа **HTTP **запросом на **url **с префиксом **/integration/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
83	83
84	84	В ответ Топаз "Web Офис" дает ответ в формате **JSON**{{{}}}
85	85
...	...	@@ -98,7 +98,20 @@
98	98	{{/code}}
99	99
100	100
	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}}
101	101
	105	+
102	102	**Пример ответа**{{{}}}
103	103
104	104	{{code language="javascript"}}
...	...	@@ -113,7 +113,7 @@
113	113
114	114	[[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2]]
115	115
116		-Информирование Топаз "Web Офис" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
	120	+Информирование Топаз "Web Офис" о заказе и их статусах осуществляется **HTTP **запросом на **url **с префиксом **/integration/order **, запрос типа **POST **, timeout 10 секунд.
117	117
118	118
119	119	**Тело запроса содержит JSON вида Order**{{{}}}
...	...	@@ -191,7 +191,7 @@
191	191
192	192	В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
193	193
194		-**baseUrl + /api/order/accept POST**
	198	+**базовый url + /api/order/accept POST**
195	195
196	196	**apikey={apikey}&orderId={ordeId}**
197	197
...	...	@@ -205,7 +205,7 @@
205	205
206	206	В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
207	207
208		-**baseUrl + /api/order/fueling POST**
	212	+**базовый url + /api/order/fueling POST**
209	209
210	210	**apikey={apikey}&orderId={ordeId}**
211	211
...	...	@@ -215,7 +215,7 @@
215	215
216	216	Данный статус сообщает внешней системе о том, что заказ следует отменить
217	217
218		-**baseUrl + /api/order/canceled**
	222	+**базовый url + /api/order/canceled**
219	219
220	220	**POST**
221	221
...	...	@@ -231,7 +231,7 @@
231	231
232	232	В случае если внешняя система дала ответ отличный от **200 ОК **, то Топаз "Web Офис" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
233	233
234		-**baseUrl + /api/order/completed POST**
	238	+**базовый url + /api/order/completed POST**
235	235
236	236	**apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&**
237	237
...	...	@@ -249,7 +249,7 @@
249	249
250	250	Для этого с периодичностью от 5 – 10 секунд Топаз "Web Офис" выполняет следующий запрос
251	251
252		-**baseUrl + /api/order/volume**
	256	+**базовый url + /api/order/volume**
253	253
254	254	**POST**
255	255
...	...	@@ -261,9 +261,9 @@
261	261
262	262	== Проверка статуса работы станции ==
263	263
264		-Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
	268	+Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ url с префиксом
265	265
266		-**/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
	270	+**/integration/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
267	267
268	268	**columnId **– идентификатор ТРК
269	269