Перейти к содержимому
Редактировал(а) Dmitriy 2026/04/23 06:18
От версии 28.1
отредактировано Ярослава Ерина
на 2024/12/11 12:27
Изменить комментарий: К данной версии нет комментариев
К версии 36.2
отредактировано Ярослава Ерина
на 2025/01/17 07:38
Изменить комментарий: Update document after refactoring.

Сводка

Подробности

Свойства страницы
Родительский документ
... ... @@ -1,1 +1,1 @@
1 -Main.WebHome
1 +Внешние API.Внешние наливы.WebHome
Содержимое
... ... @@ -1,5 +3,3 @@
1 -{{toc/}}
2 -
3 3  v 1.0.1
4 4  
5 5  == Настройка перед интеграцией ==
... ... @@ -22,7 +22,7 @@
22 22  (((
23 23  (% class="wikigeneratedid" id="H41443043D43D44B43943A43B44E44743D43543E43144543E43443843C43E43144343443544243F43544043543443043243044244C43243E43244143544543743043F44043E44143044543E44243243D43544843D43543944143844144243543C44B4322242243E43F430437-WebOffice2243243743043343E43B43E43243A43528header29externalSystemApikey" %)
24 24  (((
25 -**Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey**
23 +=== **Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey** ===
26 26  )))
27 27  )))
28 28  
... ... @@ -36,6 +36,7 @@
36 36  
37 37  Базовым адресом **(baseUrl)** для выполнения запросов является [[https:~~/~~/topazoffice.ru/ms/external-fueling/integration>>https://topazoffice.ru/ms/external-fueling/integration]]
38 38  
37 +----
39 39  
40 40  == **Методы API "Топаз-Web Office":** ==
41 41  
... ... @@ -81,7 +81,8 @@
81 81  
82 82  **Возможные идентификаторы топлива**
83 83  
84 -|ID|Марка
83 +(% border="1" %)
84 +|(% style="background-color:#e5e4e2; border-color:black" %)ID|(% style="background-color:#e5e4e2; border-color:black" %)Марка
85 85  |diesel|дизель
86 86  |diesel_premium|брендированный дизель
87 87  |a80|бензин марки А80
... ... @@ -96,6 +96,8 @@
96 96  |propane|газ пропан
97 97  |metan|метан
98 98  
99 +== ==
100 +
99 99  == Получение прайс-листа ==
100 100  
101 101  Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
... ... @@ -116,7 +116,6 @@
116 116  }
117 117  {{/code}}
118 118  
119 -
120 120  **Пример ответа**{{{}}}
121 121  
122 122  {{code language="javascript"}}
... ... @@ -127,13 +127,14 @@
127 127  }
128 128  {{/code}}
129 129  
131 +== ==
132 +
130 130  == Получение и обработка заказа ==
131 131  
132 -[[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"]]
133 133  
134 134  Информирование "Топаз-Web Office" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
135 135  
136 -
137 137  **Тело запроса содержит JSON вида Order{{{}}}**
138 138  
139 139  {{code language="javascript" layout="LINENUMBERS"}}
... ... @@ -237,8 +237,10 @@
237 237  
238 238  **200 ОК **– станция и ТРК готова принять и обработать заказ
239 239  
240 -**400 **– станция или ТРК не найдена (не верный идентификатор станции или ТРК) **404 **– ТРК занята / ТРК не готова принять заказ
242 +**400 **– станция или ТРК не найдена (неверный идентификатор станции или ТРК)
241 241  
244 +**404 **– ТРК занята / ТРК не готова принять заказ
245 +
242 242  любой ответ не **200 ОК **– интерпретируется как на станции нет интернета / станция не доступна
243 243  
244 244  ----
... ... @@ -271,6 +271,8 @@
271 271  
272 272  все параметры являются обязательными
273 273  
278 +=== ===
279 +
274 274  === **Статус Fueling** ===
275 275  
276 276  Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
... ... @@ -287,6 +287,8 @@
287 287  
288 288  все параметры являются обязательными
289 289  
296 +=== ===
297 +
290 290  === **Статус Canceled** ===
291 291  
292 292  Данный статус сообщает внешней системе о том, что заказ следует отменить
... ... @@ -301,6 +301,8 @@
301 301  
302 302  **reason – **текстовая причина отмены
303 303  
312 +=== ===
313 +
304 304  === **Статус Completed** ===
305 305  
306 306  Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
... ... @@ -317,6 +317,8 @@
317 317  
318 318  **extendedDate **– дата по которой АСУ строит отчет для сверки, формат **dd.MM.yyyy HH:mm:ss**
319 319  
330 +=== ===
331 +
320 320  === **Отправка счетчика налива** ===
321 321  
322 322  В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива