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

Сводка

Подробности

Свойства страницы
Родительский документ
... ... @@ -1,1 +1,1 @@
1 -vneshnie_api.Внешние наливы.WebHome
1 +Main.WebHome
Автор документа
... ... @@ -1,1 +1,1 @@
1 -XWiki.erin_ds
1 +XWiki.erina_jv
Содержимое
... ... @@ -1,9 +1,9 @@
1 -v 1.0.1
1 +====== **v 1.0.1** ======
2 2  
3 3  == Настройка перед интеграцией ==
4 4  
5 5  
6 -Перед началом интеграции, уполномоченный сотрудник компании, предоставляющей услуги внешних наливов (далее Интегратор), передает в ООО "Топаз-сервис" следующую информацию:
6 +Перед началом интеграции, уполномоченный сотрудник компании, предоставляющей услуги внешних наливов, передает в ООО "Топаз-сервис" следующую информацию:
7 7  
8 8  1. Базовый url тестового окружения системы внешнего налива
9 9  1. Список ip адресов, с которых будут приходить запросы от тестового окружения системы внешнего налива
... ... @@ -14,65 +14,38 @@
14 14  
15 15  После получения информации по указанным пунктам, от ООО "Топаз-сервис" будет предоставлен тестовый доступ для настройки интеграции.
16 16  
17 -Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в "Топаз-Web Office".
17 +Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в Топаз "Web Офис". Данный ключ необходимо будет передавать во всех запросах от внешней системы в Топаз "Web Офис" в заголовке externalSystemApikey
18 18  
19 -(% class="box errormessage" %)
20 -(((
21 -(% class="wikigeneratedid" id="H41443043D43D44B43943A43B44E44743D43543E43144543E43443843C43E43144343443544243F43544043543443043243044244C43243E43244143544543743043F44043E44143044543E44243243D43544843D43543944143844144243543C44B4322242243E43F430437-WebOffice2243243743043343E43B43E43243A43528header29externalSystemApikey" %)
22 -(((
23 -=== **Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey** ===
24 -)))
25 -)))
26 -
27 -== ApiKey ==
28 -
29 -(% class="wikigeneratedid" %)
30 -Интегратору необходимо для каждого своего клиента (сети АЗС) сформировать и хранить в собственной базе данных уникальный Apikey.
31 -С помощью этого Apikey происходит идентификация клиента (сети АЗС) при обмене между "Топаз-Web Office" и системой Интегратора.
32 -
33 -== Адрес для отправки запросов ==
34 -
35 -Базовым адресом **(baseUrl)** для выполнения запросов является [[https:~~/~~/topazoffice.ru/ms/external-fueling/integration>>https://topazoffice.ru/ms/external-fueling/integration]]
36 -
37 -----
38 -
39 -== **Методы API "Топаз-Web Office":** ==
40 -
41 -1. **Получение списка АЗС и их конфигураций**
42 -1. **Получение прайс-листа**
43 -1. **Получение и обработка заказа**
44 -1. **Проверка статуса работы станции**
45 -
46 46  == Получение списка АЗС и их конфигураций ==
47 47  
48 -Внешняя система опрашивает "Топаз-Web Office" для получения списка АЗС и их конфигураций **через HTTP **запрос на **baseUrl **с префиксом **/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
21 +Внешняя система опрашивает Топаз "Web Офис" для получения списка АЗС и их конфигураций **через HTTP **запрос на **url **с префиксом **/integration/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
49 49  
50 50  В ответ Топаз "Web Офис" дает ответ в формате **JSON**
51 51  
52 52  **...**
53 53  
54 -{{code language="javascript" layout="LINENUMBERS"}}
27 +{{code language="javascript"}}
55 55  {
56 56  // идентификатор станции АЗС
57 -string id
30 +string Id
58 58  // статус станции: true – доступна, false – выключена
59 -bool enable,
32 +bool Enable,
60 60  // наименование станции
61 -string name,
34 +string Name,
62 62  // адрес станции
63 -string address,
36 +string Address,
64 64  // гео точка на карте
65 -location location
38 +location Location
66 66  {
67 -double lat,
68 -double lon },
40 +double Lat,
41 +double Lon },
69 69  // словарь доступных ТРК
70 -Dictionary columns {
43 +Dictionary Columns {
71 71  // номер колонки
72 72  (int32) Key:
73 73  {
74 74  // список доступных типов топлива
75 -"fuels": [ "a92", "a95", "diesel_premium", ... N ]
48 +"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" %)Марка
56 +|ID|Марка
85 85  |diesel|дизель
86 86  |diesel_premium|брендированный дизель
87 87  |a80|бензин марки А80
... ... @@ -96,119 +96,71 @@
96 96  |propane|газ пропан
97 97  |metan|метан
98 98  
99 -== ==
100 -
101 101  == Получение прайс-листа ==
102 102  
103 -Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
73 +Внешняя система опрашивает Топаз "Web Офис" для получения прайс-листа **HTTP **запросом на **url **с префиксом **/integration/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
104 104  
105 105  В ответ Топаз "Web Офис" дает ответ в формате **JSON**{{{}}}
106 106  
107 -{{code language="javascript" layout="LINENUMBERS"}}
77 +{{code language="javascript"}}
108 108  {
109 109   {
110 110   // идентификатор станции внутри Топаз "Web Офис"
111 - string stationId,
81 + string StationId,
112 112   // идентификатор топлива
113 - string productId,
83 + string ProductId,
114 114   // цена за 1 литр
115 - double price
116 - // Внешний код топлива
117 - string fuelExtendedId
85 + double Price
118 118   },
119 119  …. N
120 120  }
121 121  {{/code}}
122 122  
123 -**Пример ответа**{{{}}}
124 124  
125 125  {{code language="javascript"}}
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"},
93 +{
94 +{
95 +// идентификатор станции внутри Топаз "Web Офис"
96 +string StationId, 
97 +// идентификатор топлива 
98 +string ProductId, 
99 +// цена за 1 литр 
100 +double Price 
101 +}, …. N 
130 130  }
131 131  {{/code}}
132 132  
133 -== ==
134 134  
135 -== Получение и обработка заказа ==
106 +**Пример ответа**{{{}}}
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"]]
138 -
139 -Информирование "Топаз-Web Office" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
140 -
141 -**Тело запроса содержит JSON вида Order{{{}}}**
142 -
143 -{{code language="javascript" layout="LINENUMBERS"}}
108 +{{code language="javascript"}}
144 144  {
145 -// Идентификатор заказа
146 -String Id
147 -// дата и время создания в UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
148 -String DateCreate
149 -// идентификатор станции АЗС
150 -String StationExtendedId
151 -// Тип заказа
152 -String OrderType
153 -// номер стороны (поста)
154 -int ColumnId
155 -// Идентификатор топлива
156 -String FuelId
157 -// Стоимость 1 литра топлива
158 -double PriceFuel
159 -// Сумма заказа
160 -double Sum
161 -// Размер заказа в литрах
162 -double Litre
163 -// Итого оплачено
164 -double SumPaid
165 -// Статус заказа
166 -OrderStatus Status
167 -// дата и время завершения заказа UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
168 -String DateEnd
169 -// Идентификатор причины отмены заказа
170 -String ReasonId
171 -// Причина отмены
172 -String Reason
173 -// Итого заправлено
174 -double LitreCompleted
175 -// Итого оплачено по завершению заказа
176 -double SumPaidCompleted
177 -// Идентификатор договора
178 -String ContractId
179 -// Способ оплаты
180 -String PayType
110 +{“StationId”: “0001”, “ProductId”: “a92”, “Price”: 38.66},
111 +{“StationId”: “0001”, “ProductId”: “a95_premium”, “Price”: 45.21},
112 +{“StationId”: “0002”, “ProductId”: “a92”, “Price”: 38.98},
181 181  }
182 182  {{/code}}
183 183  
184 -**Обязательными полями при создании нового заказа являются:**
116 +== Обработка заказа ==
185 185  
186 -{{code layout="LINENUMBERS" language="javascript"}}
187 -{
188 - "Id": "string",
189 - "DateCreate": "string",
190 - "OrderType": "Money",
191 - "StationExtendedId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
192 - "ColumnId": 0,
193 - "FuelId": "diesel"
194 - "PriceFuel": 0,
195 - "Sum": 0,
196 - "Litre": 0,
197 - "Status": "OrderCreated"
198 - "ContractId": "string"
199 -}
200 -{{/code}}
118 +[[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2]]
201 201  
120 +Информирование Топаз "Web Офис" о заказе и их статусах осуществляется **HTTP **запросом на **url **с префиксом **/integration/order **, запрос типа **POST **, timeout 10 секунд.
121 +
122 +
123 +**Тело запроса содержит JSON вида Order**
124 +
125 +{{{{ // идентификатор заказа string Id // дата и время создания в UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss String DateCreate // значение заказа double OrderVolume // идентификатор станции АЗС string StationExtendedId // номер колонки int ColumnId // идентификатор топлива string FuelId // стоимость 1 литра топлива double PriceFuel // сумма заказа double Sum // кол-во литров double Litre // итого оплачено double SumPaid // статус заказа OrderStatus Status // дата и время завершения заказа UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss String DateEnd // идентификатор причины отмены заказа string ReasonId // причина отмены string Reason // итого сумма литров залито double LitreCompleted // итого оплачено по завершению заказа double SumPaidCompleted // идентификатор договора string ContractId }}}}
126 +
202 202  Параметр **OrderType **– тип заказа может принимать следующие значения:
203 203  
204 -* **Money **– заправка на фиксированную сумму
205 -* **Liters **– заправка на литры
129 +* **Money **– заправка на фиксированную сумму, **OrderVolume **– сумма рублей
130 +* **Liters **– заправка на литры, **OrderVolume **– кол-вол литров
206 206  
207 207  Параметр **Status **– статус заказа может принимать следующие значения
208 208  
209 209  * **OrderCreated **– заказ создан и полностью оплачен
210 -* **Accepted **- АЗС готова начать налив
211 -* **Expired **– статус от АЗС не поступил в течение 30 минут
135 +* **Expire **– статус от АЗС не поступил в течение 30 минут
212 212  * **Completed **– заказа завершен успешно
213 213  * **StationCanceled **– заказ отменен оператором АЗС или же Топаз "Web Офис"
214 214  * **UserCanceled **– заказ отменен пользователем
... ... @@ -222,86 +222,43 @@
222 222  
223 223  При получении заказа в статусе **OrderCreated **Топаз "Web Офис" проверяет ряд параметров **StationExtendedId **– в случае если идентификатор станции не найден в Топаз "Web Офис", то Топаз "Web Офис" дает ответ **400**
224 224  
225 -**FuelId **+ **PriceFuel **– в случае если стоимость топлива в Топаз "Web Офис" отличается от присланной, то Топаз "Web Офис" дает ответ **402.**
149 +**FuelId **+ **PriceFuel **– в случае если стоимость топлива в Топаз "Web Офис" отличается от присланной, то Топаз "Web Офис" дает ответ **402**
226 226  
151 +== Передача статусов о заказе ==
227 227  
228 -== Проверка статуса работы станции ==
153 +=== Статус Accept ===
229 229  
230 -Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
155 +Данный статус сообщает внешней системе о том, что заказ принят и обработан в Топаз "Web Офис"
231 231  
232 -**/ping?apikey={apikey}&stationId={stationId}&columnId={columnId},**
157 +Данный статус Топаз "Web Офис"отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
233 233  
234 -**stationId **– идентификатор станции
159 +В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
235 235  
236 -**columnId **– идентификатор стороны ТРК
161 +**базовый url + /api/order/accept POST**
237 237  
238 -запрос типа **GET **, timeout 10 секунд.
239 -
240 -==== **Статусы ответов** ====
241 -
242 -**200 ОК **– станция и ТРК готова принять и обработать заказ
243 -
244 -**400 **– станция или ТРК не найдена (неверный идентификатор станции или ТРК)
245 -
246 -**404 **– ТРК занята / ТРК не готова принять заказ
247 -
248 -любой ответ не **200 ОК **– интерпретируется как на станции нет интернета / станция не доступна
249 -
250 -----
251 -
252 -Для получения статусов Интегратору необходимо со своей стороны реализовать сервис для их получения и обработки.
253 -
254 -== **Методы REST API интегратора (внешней системы):** ==
255 -
256 -1. **Статус Accepted**
257 -1. **Статус Fueling**
258 -1. **Статус Canceled**
259 -1. **Статус Completed**
260 -1. **Отправка счетчика налива**
261 -
262 -Данные запросы "Топаз-Web Office" отправляет Интегратору.
263 -
264 -=== **Статус Accepted** ===
265 -
266 -Данный статус сообщает внешней системе о том, что заказ принят и обработан в "Топаз-Web Office"
267 -
268 -Данный статус "Топаз-Web Office" отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
269 -
270 -В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
271 -
272 -**baseUrl + /api/order/accept**
273 -
274 -**POST**
275 -
276 276  **apikey={apikey}&orderId={ordeId}**
277 277  
278 278  все параметры являются обязательными
279 279  
280 -=== ===
167 +=== Статус Fueling ===
281 281  
282 -=== **Статус Fueling** ===
169 +Данный статус сообщает внешней системе о том, что Топаз "Web Офис" готов запустить колонку (начать пролив)
283 283  
284 -Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
171 +Данный статус Топаз "Web Офис" отсылает перед началом пуска колонки
285 285  
286 -Данный статус "Топаз-Web Office" отсылает перед началом пуска колонки
173 +В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
287 287  
288 -В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
175 +**базовый url + /api/order/fueling POST**
289 289  
290 -**baseUrl + /api/order/fueling**
291 -
292 -**POST**
293 -
294 294  **apikey={apikey}&orderId={ordeId}**
295 295  
296 296  все параметры являются обязательными
297 297  
298 -=== ===
181 +=== Статус Canceled ===
299 299  
300 -=== **Статус Canceled** ===
301 -
302 302  Данный статус сообщает внешней системе о том, что заказ следует отменить
303 303  
304 -**baseUrl + /api/order/canceled**
185 +**базовый url + /api/order/canceled**
305 305  
306 306  **POST**
307 307  
... ... @@ -311,18 +311,18 @@
311 311  
312 312  **reason – **текстовая причина отмены
313 313  
314 -=== ===
195 +=== Статус Completed ===
315 315  
316 -=== **Статус Completed** ===
317 -
318 318  Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
319 319  
320 -В случае если внешняя система дала ответ отличный от **200 ОК **, то "Топаз-Web Office" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
199 +В случае если внешняя система дала ответ отличный от **200 ОК **, то Топаз "Web Офис" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
321 321  
322 -**baseUrl + /api/order/completed POST**
201 +**базовый url + /api/order/completed POST**
323 323  
324 -**apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&extendedDate={extendedDate}**
203 +**apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&**
325 325  
205 +**extendedDate={extendedDate}**
206 +
326 326  все параметры являются обязательными
327 327  
328 328  **litre **– кол-во пролитых литров, указывается как **double **с разделителем точка **extendedOrderId **– идентификатор заказа в АСУ сети
... ... @@ -329,16 +329,14 @@
329 329  
330 330  **extendedDate **– дата по которой АСУ строит отчет для сверки, формат **dd.MM.yyyy HH:mm:ss**
331 331  
332 -=== ===
213 +=== Отправка счетчика налива ===
333 333  
334 -=== **Отправка счетчика налива** ===
215 +В момент процесса налива Топаз "Web Офис" может сообщать внешней системе статус счетчика налива
335 335  
336 -В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива
217 +Для этого с периодичностью от 5 – 10 секунд Топаз "Web Офис" выполняет следующий запрос
337 337  
338 -Для этого с периодичностью от 5 – 10 секунд "Топаз-Web Office" выполняет следующий запрос
219 +**базовый url + /api/order/volume**
339 339  
340 -**baseUrl + /api/order/volume**
341 -
342 342  **POST**
343 343  
344 344  **apikey={apikey}&orderId={ordeId}&litre={litre}**
... ... @@ -346,3 +346,21 @@
346 346  все параметры являются обязательными
347 347  
348 348  **litre **– кол-во пролитых на момент отправки запроса литров, указывается как double с разделителем точка
228 +
229 +== Проверка статуса работы станции ==
230 +
231 +Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ url с префиксом
232 +
233 +**/integration/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
234 +
235 +**columnId **– идентификатор ТРК
236 +
237 +запрос типа **GET **, timeout 10 секунд.
238 +
239 +== Статусы ответов ==
240 +
241 +**200 ОК **– станция и ТРК готова принять и обработать заказ
242 +
243 +**400 **– станция или ТРК не найдена (не верный идентификатор станции или ТРК) **404 **– ТРК занята / ТРК не готова принять заказ
244 +
245 +любой ответ не **200 ОК **– интерпретируется как на станции нет интернета / станция не доступна