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

Сводка

Подробности

Свойства страницы
Родительский документ
... ... @@ -1,1 +1,1 @@
1 -Внешние API.Внешние наливы.WebHome
1 +Main.WebHome
Автор документа
... ... @@ -1,1 +1,1 @@
1 -XWiki.erin_ds
1 +XWiki.erina_jv
Содержимое
... ... @@ -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,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  
... ... @@ -54,25 +54,25 @@
54 54  {{code language="javascript" layout="LINENUMBERS"}}
55 55  {
56 56  // идентификатор станции АЗС
57 -string id
56 +string Id
58 58  // статус станции: true – доступна, false – выключена
59 -bool enable,
58 +bool Enable,
60 60  // наименование станции
61 -string name,
60 +string Name,
62 62  // адрес станции
63 -string address,
62 +string Address,
64 64  // гео точка на карте
65 -location location
64 +location Location
66 66  {
67 -double lat,
68 -double lon },
66 +double Lat,
67 +double Lon },
69 69  // словарь доступных ТРК
70 -Dictionary columns {
69 +Dictionary Columns {
71 71  // номер колонки
72 72  (int32) Key:
73 73  {
74 74  // список доступных типов топлива
75 -"fuels": [ "a92", "a95", "diesel_premium", ... N ]
74 +"Fuels": [ "a92", "a95", "diesel_premium", ... N ]
76 76  }
77 77  } ... N
78 78  }
... ... @@ -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" %)Марка
82 +|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секунд.
... ... @@ -108,36 +108,34 @@
108 108  {
109 109   {
110 110   // идентификатор станции внутри Топаз "Web Офис"
111 - string stationId,
107 + string StationId,
112 112   // идентификатор топлива
113 - string productId,
109 + string ProductId,
114 114   // цена за 1 литр
115 - double price
116 - // Внешний код топлива
117 - string fuelExtendedId
111 + double Price
118 118   },
119 119  …. N
120 120  }
121 121  {{/code}}
122 122  
117 +
123 123  **Пример ответа**{{{}}}
124 124  
125 125  {{code language="javascript"}}
126 126  {
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"},
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},
130 130  }
131 131  {{/code}}
132 132  
133 -== ==
134 -
135 135  == Получение и обработка заказа ==
136 136  
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"]]
130 +[[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2]]
138 138  
139 139  Информирование "Топаз-Web Office" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
140 140  
134 +
141 141  **Тело запроса содержит JSON вида Order{{{}}}**
142 142  
143 143  {{code language="javascript" layout="LINENUMBERS"}}
... ... @@ -241,10 +241,8 @@
241 241  
242 242  **200 ОК **– станция и ТРК готова принять и обработать заказ
243 243  
244 -**400 **– станция или ТРК не найдена (неверный идентификатор станции или ТРК)
238 +**400 **– станция или ТРК не найдена (не верный идентификатор станции или ТРК) **404 **– ТРК занята / ТРК не готова принять заказ
245 245  
246 -**404 **– ТРК занята / ТРК не готова принять заказ
247 -
248 248  любой ответ не **200 ОК **– интерпретируется как на станции нет интернета / станция не доступна
249 249  
250 250  ----
... ... @@ -277,8 +277,6 @@
277 277  
278 278  все параметры являются обязательными
279 279  
280 -=== ===
281 -
282 282  === **Статус Fueling** ===
283 283  
284 284  Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
... ... @@ -295,8 +295,6 @@
295 295  
296 296  все параметры являются обязательными
297 297  
298 -=== ===
299 -
300 300  === **Статус Canceled** ===
301 301  
302 302  Данный статус сообщает внешней системе о том, что заказ следует отменить
... ... @@ -311,8 +311,6 @@
311 311  
312 312  **reason – **текстовая причина отмены
313 313  
314 -=== ===
315 -
316 316  === **Статус Completed** ===
317 317  
318 318  Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
... ... @@ -329,8 +329,6 @@
329 329  
330 330  **extendedDate **– дата по которой АСУ строит отчет для сверки, формат **dd.MM.yyyy HH:mm:ss**
331 331  
332 -=== ===
333 -
334 334  === **Отправка счетчика налива** ===
335 335  
336 336  В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива