Перейти к содержимому
Редактировал(а) Dmitriy 2026/04/23 06:18
От версии 30.1
отредактировано Ярослава Ерина
на 2024/12/11 12:30
Изменить комментарий: К данной версии нет комментариев
К версии 49.1
отредактировано Dmitriy
на 2026/04/13 12:45
Изменить комментарий: К данной версии нет комментариев

Сводка

Подробности

Свойства страницы
Родительский документ
... ... @@ -1,1 +1,1 @@
1 -Main.WebHome
1 +vneshnie_api.vneshnie_nalivy2.WebHome
Автор документа
... ... @@ -1,1 +1,1 @@
1 -XWiki.erina_jv
1 +XWiki.erin_ds
Содержимое
... ... @@ -1,28 +3,33 @@
1 -{{toc/}}
2 -
3 3  v 1.0.1
4 4  
5 5  == Настройка перед интеграцией ==
6 6  
5 +Для начала работы необходимо зарегистрироваться в Личном кабинете Интегратора
7 7  
8 -Перед началом интеграции, уполномоченный сотрудник компании, предоставляющей услуги внешних наливов (далее Интегратор), передает в ООО "Топаз-сервис" следующую информацию:
7 +~1. Для регистрации пройдите по ссылке: [[https:~~/~~/topazoffice.ru/#/auth/integrator-registration/ef>>https://topazoffice.ru/#/auth/integrator-registration/ef]] 
9 9  
10 -1. Базовый url тестового окружения системы внешнего налива
11 -1. Список ip адресов, с которых будут приходить запросы от тестового окружения системы внешнего налива
12 -1. Базовый url боевого окружения системы внешнего налива
13 -1. Список ip адресов, с которых будут приходить запросы от боевого окружения системы внешнего налива
14 -1. Официальное название системы внешних наливов, которое будет указано в Топаз "Web Офис"
15 -1. Иконку системы внешних наливов в формате svg с соотношением сторон 1:1
9 +2. После ввода логина и пароля на почту будет отправлено письмо для подтверждения регистрации
16 16  
17 -После получения информации по указанным пунктам, от ООО "Топаз-сервис" будет предоставлен тестовый доступ для настройки интеграции.
11 +3. Перейдите по ссылке из письма для подтверждения учетной записи.
18 18  
19 -Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в "Топаз-Web Office".
13 +4. Авторизуйтесь в Топаз Web-Office ([[https:~~/~~/topazoffice.ru/#/login>>url:https://topazoffice.ru/#/login]] )
20 20  
15 +5. В открывшейся форме заполните поля:
16 +
17 +* Официальное название системы внешних наливов, которое будет указано в Топаз "Web Офис"
18 +* Прикрепите иконку Вашей системы  в формате svg с соотношением сторон 1:1. Эти название и иконку будут видеть конечные клиенты  в Топаз "Web Офис"
19 +* Базовый url тестового окружения системы внешнего налива
20 +* Список ip адресов, с которых будут приходить запросы от тестового окружения системы внешнего налива
21 +* Базовый url боевого окружения системы внешнего налива
22 +* Список ip адресов, с которых будут приходить запросы от боевого окружения системы внешнего налива
23 +
24 +6. Нажмите на кнопку "Создать", после этого вы получите уникальный API-ключ, он отобразится в соответствующем поле.
25 +
21 21  (% class="box errormessage" %)
22 22  (((
23 23  (% class="wikigeneratedid" id="H41443043D43D44B43943A43B44E44743D43543E43144543E43443843C43E43144343443544243F43544043543443043243044244C43243E43244143544543743043F44043E44143044543E44243243D43544843D43543944143844144243543C44B4322242243E43F430437-WebOffice2243243743043343E43B43E43243A43528header29externalSystemApikey" %)
24 24  (((
25 -**Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey**
30 +=== **Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey** ===
26 26  )))
27 27  )))
28 28  
... ... @@ -36,6 +36,7 @@
36 36  
37 37  Базовым адресом **(baseUrl)** для выполнения запросов является [[https:~~/~~/topazoffice.ru/ms/external-fueling/integration>>https://topazoffice.ru/ms/external-fueling/integration]]
38 38  
44 +----
39 39  
40 40  == **Методы API "Топаз-Web Office":** ==
41 41  
... ... @@ -55,25 +55,25 @@
55 55  {{code language="javascript" layout="LINENUMBERS"}}
56 56  {
57 57  // идентификатор станции АЗС
58 -string Id
64 +string id
59 59  // статус станции: true – доступна, false – выключена
60 -bool Enable,
66 +bool enable,
61 61  // наименование станции
62 -string Name,
68 +string name,
63 63  // адрес станции
64 -string Address,
70 +string address,
65 65  // гео точка на карте
66 -location Location
72 +location location
67 67  {
68 -double Lat,
69 -double Lon },
74 +double lat,
75 +double lon },
70 70  // словарь доступных ТРК
71 -Dictionary Columns {
77 +Dictionary columns {
72 72  // номер колонки
73 73  (int32) Key:
74 74  {
75 75  // список доступных типов топлива
76 -"Fuels": [ "a92", "a95", "diesel_premium", ... N ]
82 +"fuels": [ "a92", "a95", "diesel_premium", ... N ]
77 77  }
78 78  } ... N
79 79  }
... ... @@ -81,7 +81,8 @@
81 81  
82 82  **Возможные идентификаторы топлива**
83 83  
84 -|ID|Марка
90 +(% border="1" %)
91 +|(% style="background-color:#e5e4e2; border-color:black" %)ID|(% style="background-color:#e5e4e2; border-color:black" %)Марка
85 85  |diesel|дизель
86 86  |diesel_premium|брендированный дизель
87 87  |a80|бензин марки А80
... ... @@ -96,6 +96,8 @@
96 96  |propane|газ пропан
97 97  |metan|метан
98 98  
106 +== ==
107 +
99 99  == Получение прайс-листа ==
100 100  
101 101  Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
... ... @@ -106,34 +106,36 @@
106 106  {
107 107   {
108 108   // идентификатор станции внутри Топаз "Web Офис"
109 - string StationId,
118 + string stationId,
110 110   // идентификатор топлива
111 - string ProductId,
120 + string productId,
112 112   // цена за 1 литр
113 - double Price
122 + double price
123 + // Внешний код топлива
124 + string fuelExtendedId
114 114   },
115 115  …. N
116 116  }
117 117  {{/code}}
118 118  
119 -
120 120  **Пример ответа**{{{}}}
121 121  
122 122  {{code language="javascript"}}
123 123  {
124 -{"StationId": "0001", "ProductId": "a92", "Price": 38.66},
125 -{"StationId": "0001", "ProductId": "a95_premium", "Price": 45.21},
126 -{"StationId": "0002", "ProductId": "a92", "Price": 38.98},
134 +{"stationId": "0001", "productId": "a92", "price": 38.66, "fuelExtendedId": "92"},
135 +{"stationId": "0001", "productId": "a95_premium", "price": 45.21, "fuelExtendedId": "95"},
136 +{"stationId": "0002", "productId": "a92", "price": 38.98, , "fuelExtendedId": "92"},
127 127  }
128 128  {{/code}}
129 129  
140 +== ==
141 +
130 130  == Получение и обработка заказа ==
131 131  
132 -[[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2]]
144 +[[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"]]
133 133  
134 134  Информирование "Топаз-Web Office" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
135 135  
136 -
137 137  **Тело запроса содержит JSON вида Order{{{}}}**
138 138  
139 139  {{code language="javascript" layout="LINENUMBERS"}}
... ... @@ -140,10 +140,12 @@
140 140  {
141 141  // Идентификатор заказа
142 142  String Id
143 -// дата и время создания в UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
154 +// дата и время создания в UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z', yyyy-MM-dd'T'HH:mm:ss.SSS'Z', либо yyyy-MM-dd HH:mm:ss
144 144  String DateCreate
145 145  // идентификатор станции АЗС
146 146  String StationExtendedId
158 +// Идентификатор АЗС в системе Интегратора (Необязательное поле)
159 +String StationId
147 147  // Тип заказа
148 148  String OrderType
149 149  // номер стороны (поста)
... ... @@ -160,7 +160,7 @@
160 160  double SumPaid
161 161  // Статус заказа
162 162  OrderStatus Status
163 -// дата и время завершения заказа UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
176 +// дата и время завершения заказа UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z', yyyy-MM-dd'T'HH:mm:ss.SSS'Z', либо yyyy-MM-dd HH:mm:ss
164 164  String DateEnd
165 165  // Идентификатор причины отмены заказа
166 166  String ReasonId
... ... @@ -221,6 +221,13 @@
221 221  **FuelId **+ **PriceFuel **– в случае если стоимость топлива в Топаз "Web Офис" отличается от присланной, то Топаз "Web Офис" дает ответ **402.**
222 222  
223 223  
237 +== Отмена заказа ==
238 +
239 +Отмена заказа возможна даже после его старта. Для инициации отмены необходимо отправить тот же заказ со статусом (% style="background-color:#dddddd; font-family:Courier New,Courier,monospace" %)**UserCanceled**(%%). Если на момент получения запроса на отмену процесс налива ещё не начался, заказ будет отменён.
240 +
241 +В случае, если отмена инициирована после начала налива, система остановит процесс пролива и зафиксирует заказ как отменённый. В этом случае в ответе будет указано количество литров, фактически налитых до момента остановки.
242 +
243 +
224 224  == Проверка статуса работы станции ==
225 225  
226 226  Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
... ... @@ -237,8 +237,10 @@
237 237  
238 238  **200 ОК **– станция и ТРК готова принять и обработать заказ
239 239  
240 -**400 **– станция или ТРК не найдена (не верный идентификатор станции или ТРК) **404 **– ТРК занята / ТРК не готова принять заказ
260 +**400 **– станция или ТРК не найдена (неверный идентификатор станции или ТРК)
241 241  
262 +**404 **– ТРК занята / ТРК не готова принять заказ
263 +
242 242  любой ответ не **200 ОК **– интерпретируется как на станции нет интернета / станция не доступна
243 243  
244 244  ----
... ... @@ -251,10 +251,15 @@
251 251  1. **Статус Fueling**
252 252  1. **Статус Canceled**
253 253  1. **Статус Completed**
254 -1. **Отправка счетчика налива**
276 +1. **Отправка счетчика налива Volume**
255 255  
256 256  Данные запросы "Топаз-Web Office" отправляет Интегратору.
257 257  
280 +(% class="box infomessage" %)
281 +(((
282 +##**Все методы, отправляющие статусы заказа (**##**Accepted, Fueling, Canceled, Completed, Volume),## отправляют данные в теле в формате x-www-form-urlencoded##**
283 +)))
284 +
258 258  === **Статус Accepted** ===
259 259  
260 260  Данный статус сообщает внешней системе о том, что заказ принят и обработан в "Топаз-Web Office"
... ... @@ -271,6 +271,8 @@
271 271  
272 272  все параметры являются обязательными
273 273  
301 +=== ===
302 +
274 274  === **Статус Fueling** ===
275 275  
276 276  Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
... ... @@ -287,6 +287,8 @@
287 287  
288 288  все параметры являются обязательными
289 289  
319 +=== ===
320 +
290 290  === **Статус Canceled** ===
291 291  
292 292  Данный статус сообщает внешней системе о том, что заказ следует отменить
... ... @@ -301,6 +301,8 @@
301 301  
302 302  **reason – **текстовая причина отмены
303 303  
335 +=== ===
336 +
304 304  === **Статус Completed** ===
305 305  
306 306  Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
... ... @@ -317,6 +317,8 @@
317 317  
318 318  **extendedDate **– дата по которой АСУ строит отчет для сверки, формат **dd.MM.yyyy HH:mm:ss**
319 319  
353 +=== ===
354 +
320 320  === **Отправка счетчика налива** ===
321 321  
322 322  В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива