Перейти к содержимому
Редактировал(а) Dmitriy 2026/04/23 06:18
От версии 32.1
отредактировано Ярослава Ерина
на 2024/12/11 12:56
Изменить комментарий: К данной версии нет комментариев
К версии 37.3
отредактировано Dmitriy
на 2025/02/19 08:59
Изменить комментарий: Update document after refactoring.

Сводка

Подробности

Свойства страницы
Родительский документ
... ... @@ -1,1 +1,1 @@
1 -Main.WebHome
1 +vneshnie_api.Внешние наливы.WebHome
Автор документа
... ... @@ -1,1 +1,1 @@
1 -XWiki.erina_jv
1 +XWiki.erin_ds
Содержимое
... ... @@ -20,7 +20,7 @@
20 20  (((
21 21  (% class="wikigeneratedid" id="H41443043D43D44B43943A43B44E44743D43543E43144543E43443843C43E43144343443544243F43544043543443043243044244C43243E43244143544543743043F44043E44143044543E44243243D43544843D43543944143844144243543C44B4322242243E43F430437-WebOffice2243243743043343E43B43E43243A43528header29externalSystemApikey" %)
22 22  (((
23 -**Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey**
23 +=== **Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey** ===
24 24  )))
25 25  )))
26 26  
... ... @@ -34,6 +34,7 @@
34 34  
35 35  Базовым адресом **(baseUrl)** для выполнения запросов является [[https:~~/~~/topazoffice.ru/ms/external-fueling/integration>>https://topazoffice.ru/ms/external-fueling/integration]]
36 36  
37 +----
37 37  
38 38  == **Методы API "Топаз-Web Office":** ==
39 39  
... ... @@ -53,25 +53,25 @@
53 53  {{code language="javascript" layout="LINENUMBERS"}}
54 54  {
55 55  // идентификатор станции АЗС
56 -string Id
57 +string id
57 57  // статус станции: true – доступна, false – выключена
58 -bool Enable,
59 +bool enable,
59 59  // наименование станции
60 -string Name,
61 +string name,
61 61  // адрес станции
62 -string Address,
63 +string address,
63 63  // гео точка на карте
64 -location Location
65 +location location
65 65  {
66 -double Lat,
67 -double Lon },
67 +double lat,
68 +double lon },
68 68  // словарь доступных ТРК
69 -Dictionary Columns {
70 +Dictionary columns {
70 70  // номер колонки
71 71  (int32) Key:
72 72  {
73 73  // список доступных типов топлива
74 -"Fuels": [ "a92", "a95", "diesel_premium", ... N ]
75 +"fuels": [ "a92", "a95", "diesel_premium", ... N ]
75 75  }
76 76  } ... N
77 77  }
... ... @@ -79,7 +79,8 @@
79 79  
80 80  **Возможные идентификаторы топлива**
81 81  
82 -|ID|Марка
83 +(% border="1" %)
84 +|(% style="background-color:#e5e4e2; border-color:black" %)ID|(% style="background-color:#e5e4e2; border-color:black" %)Марка
83 83  |diesel|дизель
84 84  |diesel_premium|брендированный дизель
85 85  |a80|бензин марки А80
... ... @@ -94,6 +94,8 @@
94 94  |propane|газ пропан
95 95  |metan|метан
96 96  
99 +== ==
100 +
97 97  == Получение прайс-листа ==
98 98  
99 99  Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
... ... @@ -104,34 +104,36 @@
104 104  {
105 105   {
106 106   // идентификатор станции внутри Топаз "Web Офис"
107 - string StationId,
111 + string stationId,
108 108   // идентификатор топлива
109 - string ProductId,
113 + string productId,
110 110   // цена за 1 литр
111 - double Price
115 + double price
116 + // Внешний код топлива
117 + string fuelExtendedId
112 112   },
113 113  …. N
114 114  }
115 115  {{/code}}
116 116  
117 -
118 118  **Пример ответа**{{{}}}
119 119  
120 120  {{code language="javascript"}}
121 121  {
122 -{"StationId": "0001", "ProductId": "a92", "Price": 38.66},
123 -{"StationId": "0001", "ProductId": "a95_premium", "Price": 45.21},
124 -{"StationId": "0002", "ProductId": "a92", "Price": 38.98},
127 +{"stationId": "0001", "productId": "a92", "price": 38.66, "fuelExtendedId": "92"},
128 +{"stationId": "0001", "productId": "a95_premium", "price": 45.21, "fuelExtendedId": "95"},
129 +{"stationId": "0002", "productId": "a92", "price": 38.98, , "fuelExtendedId": "92"},
125 125  }
126 126  {{/code}}
127 127  
133 +== ==
134 +
128 128  == Получение и обработка заказа ==
129 129  
130 -[[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2]]
137 +[[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"]]
131 131  
132 132  Информирование "Топаз-Web Office" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
133 133  
134 -
135 135  **Тело запроса содержит JSON вида Order{{{}}}**
136 136  
137 137  {{code language="javascript" layout="LINENUMBERS"}}
... ... @@ -235,8 +235,10 @@
235 235  
236 236  **200 ОК **– станция и ТРК готова принять и обработать заказ
237 237  
238 -**400 **– станция или ТРК не найдена (не верный идентификатор станции или ТРК) **404 **– ТРК занята / ТРК не готова принять заказ
244 +**400 **– станция или ТРК не найдена (неверный идентификатор станции или ТРК)
239 239  
246 +**404 **– ТРК занята / ТРК не готова принять заказ
247 +
240 240  любой ответ не **200 ОК **– интерпретируется как на станции нет интернета / станция не доступна
241 241  
242 242  ----
... ... @@ -269,6 +269,8 @@
269 269  
270 270  все параметры являются обязательными
271 271  
280 +=== ===
281 +
272 272  === **Статус Fueling** ===
273 273  
274 274  Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
... ... @@ -285,6 +285,8 @@
285 285  
286 286  все параметры являются обязательными
287 287  
298 +=== ===
299 +
288 288  === **Статус Canceled** ===
289 289  
290 290  Данный статус сообщает внешней системе о том, что заказ следует отменить
... ... @@ -299,6 +299,8 @@
299 299  
300 300  **reason – **текстовая причина отмены
301 301  
314 +=== ===
315 +
302 302  === **Статус Completed** ===
303 303  
304 304  Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
... ... @@ -315,6 +315,8 @@
315 315  
316 316  **extendedDate **– дата по которой АСУ строит отчет для сверки, формат **dd.MM.yyyy HH:mm:ss**
317 317  
332 +=== ===
333 +
318 318  === **Отправка счетчика налива** ===
319 319  
320 320  В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива