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

Сводка

Подробности

Свойства страницы
Родительский документ
... ... @@ -1,1 +1,1 @@
1 -Внешние API.Внешние наливы.WebHome
1 +Main.WebHome
Содержимое
... ... @@ -1,4 +1,4 @@
1 -v 1.0.1
1 +====== **v 1.0.1** ======
2 2  
3 3  == Настройка перед интеграцией ==
4 4  
... ... @@ -18,11 +18,8 @@
18 18  
19 19  (% class="box errormessage" %)
20 20  (((
21 -(% class="wikigeneratedid" id="H41443043D43D44B43943A43B44E44743D43543E43144543E43443843C43E43144343443544243F43544043543443043243044244C43243E43244143544543743043F44043E44143044543E44243243D43544843D43543944143844144243543C44B4322242243E43F430437-WebOffice2243243743043343E43B43E43243A43528header29externalSystemApikey" %)
22 -(((
23 23  === **Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey** ===
24 24  )))
25 -)))
26 26  
27 27  == ApiKey ==
28 28  
... ... @@ -34,7 +34,6 @@
34 34  
35 35  Базовым адресом **(baseUrl)** для выполнения запросов является [[https:~~/~~/topazoffice.ru/ms/external-fueling/integration>>https://topazoffice.ru/ms/external-fueling/integration]]
36 36  
37 -----
38 38  
39 39  == **Методы API "Топаз-Web Office":** ==
40 40  
... ... @@ -80,8 +80,7 @@
80 80  
81 81  **Возможные идентификаторы топлива**
82 82  
83 -(% border="1" %)
84 -|(% style="background-color:#e5e4e2; border-color:black" %)ID|(% style="background-color:#e5e4e2; border-color:black" %)Марка
79 +|ID|Марка
85 85  |diesel|дизель
86 86  |diesel_premium|брендированный дизель
87 87  |a80|бензин марки А80
... ... @@ -96,8 +96,6 @@
96 96  |propane|газ пропан
97 97  |metan|метан
98 98  
99 -== ==
100 -
101 101  == Получение прайс-листа ==
102 102  
103 103  Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
... ... @@ -118,6 +118,7 @@
118 118  }
119 119  {{/code}}
120 120  
114 +
121 121  **Пример ответа**{{{}}}
122 122  
123 123  {{code language="javascript"}}
... ... @@ -128,14 +128,13 @@
128 128  }
129 129  {{/code}}
130 130  
131 -== ==
132 -
133 133  == Получение и обработка заказа ==
134 134  
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"]]
127 +[[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2]]
136 136  
137 137  Информирование "Топаз-Web Office" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
138 138  
131 +
139 139  **Тело запроса содержит JSON вида Order{{{}}}**
140 140  
141 141  {{code language="javascript" layout="LINENUMBERS"}}
... ... @@ -239,10 +239,8 @@
239 239  
240 240  **200 ОК **– станция и ТРК готова принять и обработать заказ
241 241  
242 -**400 **– станция или ТРК не найдена (неверный идентификатор станции или ТРК)
235 +**400 **– станция или ТРК не найдена (не верный идентификатор станции или ТРК) **404 **– ТРК занята / ТРК не готова принять заказ
243 243  
244 -**404 **– ТРК занята / ТРК не готова принять заказ
245 -
246 246  любой ответ не **200 ОК **– интерпретируется как на станции нет интернета / станция не доступна
247 247  
248 248  ----
... ... @@ -275,8 +275,6 @@
275 275  
276 276  все параметры являются обязательными
277 277  
278 -=== ===
279 -
280 280  === **Статус Fueling** ===
281 281  
282 282  Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
... ... @@ -293,8 +293,6 @@
293 293  
294 294  все параметры являются обязательными
295 295  
296 -=== ===
297 -
298 298  === **Статус Canceled** ===
299 299  
300 300  Данный статус сообщает внешней системе о том, что заказ следует отменить
... ... @@ -309,8 +309,6 @@
309 309  
310 310  **reason – **текстовая причина отмены
311 311  
312 -=== ===
313 -
314 314  === **Статус Completed** ===
315 315  
316 316  Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
... ... @@ -327,8 +327,6 @@
327 327  
328 328  **extendedDate **– дата по которой АСУ строит отчет для сверки, формат **dd.MM.yyyy HH:mm:ss**
329 329  
330 -=== ===
331 -
332 332  === **Отправка счетчика налива** ===
333 333  
334 334  В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива