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

Сводка

Подробности

Свойства страницы
Родительский документ
... ... @@ -1,1 +1,1 @@
1 -Main.WebHome
1 +Внешние API.Внешние наливы.WebHome
Содержимое
... ... @@ -1,4 +1,4 @@
1 -====== **v 1.0.1** ======
1 +v 1.0.1
2 2  
3 3  == Настройка перед интеграцией ==
4 4  
... ... @@ -18,8 +18,11 @@
18 18  
19 19  (% class="box errormessage" %)
20 20  (((
21 +(% class="wikigeneratedid" id="H41443043D43D44B43943A43B44E44743D43543E43144543E43443843C43E43144343443544243F43544043543443043243044244C43243E43244143544543743043F44043E44143044543E44243243D43544843D43543944143844144243543C44B4322242243E43F430437-WebOffice2243243743043343E43B43E43243A43528header29externalSystemApikey" %)
22 +(((
21 21  === **Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey** ===
22 22  )))
25 +)))
23 23  
24 24  == ApiKey ==
25 25  
... ... @@ -31,6 +31,7 @@
31 31  
32 32  Базовым адресом **(baseUrl)** для выполнения запросов является [[https:~~/~~/topazoffice.ru/ms/external-fueling/integration>>https://topazoffice.ru/ms/external-fueling/integration]]
33 33  
37 +----
34 34  
35 35  == **Методы API "Топаз-Web Office":** ==
36 36  
... ... @@ -76,7 +76,8 @@
76 76  
77 77  **Возможные идентификаторы топлива**
78 78  
79 -|ID|Марка
83 +(% border="1" %)
84 +|(% style="background-color:#e5e4e2; border-color:black" %)ID|(% style="background-color:#e5e4e2; border-color:black" %)Марка
80 80  |diesel|дизель
81 81  |diesel_premium|брендированный дизель
82 82  |a80|бензин марки А80
... ... @@ -91,6 +91,8 @@
91 91  |propane|газ пропан
92 92  |metan|метан
93 93  
99 +== ==
100 +
94 94  == Получение прайс-листа ==
95 95  
96 96  Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
... ... @@ -111,7 +111,6 @@
111 111  }
112 112  {{/code}}
113 113  
114 -
115 115  **Пример ответа**{{{}}}
116 116  
117 117  {{code language="javascript"}}
... ... @@ -122,13 +122,14 @@
122 122  }
123 123  {{/code}}
124 124  
131 +== ==
132 +
125 125  == Получение и обработка заказа ==
126 126  
127 -[[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"]]
128 128  
129 129  Информирование "Топаз-Web Office" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
130 130  
131 -
132 132  **Тело запроса содержит JSON вида Order{{{}}}**
133 133  
134 134  {{code language="javascript" layout="LINENUMBERS"}}
... ... @@ -232,8 +232,10 @@
232 232  
233 233  **200 ОК **– станция и ТРК готова принять и обработать заказ
234 234  
235 -**400 **– станция или ТРК не найдена (не верный идентификатор станции или ТРК) **404 **– ТРК занята / ТРК не готова принять заказ
242 +**400 **– станция или ТРК не найдена (неверный идентификатор станции или ТРК)
236 236  
244 +**404 **– ТРК занята / ТРК не готова принять заказ
245 +
237 237  любой ответ не **200 ОК **– интерпретируется как на станции нет интернета / станция не доступна
238 238  
239 239  ----
... ... @@ -240,7 +240,7 @@
240 240  
241 241  Для получения статусов Интегратору необходимо со своей стороны реализовать сервис для их получения и обработки.
242 242  
243 -== **Методы REST API интегратора:** ==
252 +== **Методы REST API интегратора (внешней системы):** ==
244 244  
245 245  1. **Статус Accepted**
246 246  1. **Статус Fueling**
... ... @@ -266,6 +266,8 @@
266 266  
267 267  все параметры являются обязательными
268 268  
278 +=== ===
279 +
269 269  === **Статус Fueling** ===
270 270  
271 271  Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
... ... @@ -282,6 +282,8 @@
282 282  
283 283  все параметры являются обязательными
284 284  
296 +=== ===
297 +
285 285  === **Статус Canceled** ===
286 286  
287 287  Данный статус сообщает внешней системе о том, что заказ следует отменить
... ... @@ -296,6 +296,8 @@
296 296  
297 297  **reason – **текстовая причина отмены
298 298  
312 +=== ===
313 +
299 299  === **Статус Completed** ===
300 300  
301 301  Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
... ... @@ -312,6 +312,8 @@
312 312  
313 313  **extendedDate **– дата по которой АСУ строит отчет для сверки, формат **dd.MM.yyyy HH:mm:ss**
314 314  
330 +=== ===
331 +
315 315  === **Отправка счетчика налива** ===
316 316  
317 317  В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива