Перейти к содержимому
Редактировал(а) Dmitriy 2026/04/23 06:18
От версии 33.1
отредактировано Ярослава Ерина
на 2024/12/11 12:58
Изменить комментарий: К данной версии нет комментариев
К версии 50.1
отредактировано Dmitriy
на 2026/04/15 05:05
Изменить комментарий: К данной версии нет комментариев

Сводка

Подробности

Свойства страницы
Родительский документ
... ... @@ -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
Содержимое
... ... @@ -2,25 +2,32 @@
2 2  
3 3  == Настройка перед интеграцией ==
4 4  
5 +Для начала работы необходимо зарегистрироваться в Личном кабинете Интегратора
5 5  
6 -Перед началом интеграции, уполномоченный сотрудник компании, предоставляющей услуги внешних наливов (далее Интегратор), передает в ООО "Топаз-сервис" следующую информацию:
7 +~1. Для регистрации пройдите по ссылке: [[https:~~/~~/topazoffice.ru/#/auth/integrator-registration/ef>>https://topazoffice.ru/#/auth/integrator-registration/ef]] 
7 7  
8 -1. Базовый url тестового окружения системы внешнего налива
9 -1. Список ip адресов, с которых будут приходить запросы от тестового окружения системы внешнего налива
10 -1. Базовый url боевого окружения системы внешнего налива
11 -1. Список ip адресов, с которых будут приходить запросы от боевого окружения системы внешнего налива
12 -1. Официальное название системы внешних наливов, которое будет указано в Топаз "Web Офис"
13 -1. Иконку системы внешних наливов в формате svg с соотношением сторон 1:1
9 +2. После ввода логина и пароля на почту будет отправлено письмо для подтверждения регистрации
14 14  
15 -После получения информации по указанным пунктам, от ООО "Топаз-сервис" будет предоставлен тестовый доступ для настройки интеграции.
11 +3. Перейдите по ссылке из письма для подтверждения учетной записи.
16 16  
17 -Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в "Топаз-Web Office".
13 +4. Авторизуйтесь в Топаз Web-Office ([[https:~~/~~/topazoffice.ru/#/login>>url:https://topazoffice.ru/#/login]] )
18 18  
15 +5. В открывшейся форме заполните поля:
16 +
17 +* Официальное название системы внешних наливов, которое будет указано в Топаз "Web Офис"
18 +* Прикрепите иконку Вашей системы  в формате svg с соотношением сторон 1:1. Эти название и иконку будут видеть конечные клиенты  в Топаз "Web Офис"
19 +* Базовый url тестового окружения системы внешнего налива
20 +* Список ip адресов, с которых будут приходить запросы от тестового окружения системы внешнего налива
21 +* Базовый url боевого окружения системы внешнего налива
22 +* Список ip адресов, с которых будут приходить запросы от боевого окружения системы внешнего налива
23 +
24 +6. Нажмите на кнопку "Создать", после этого вы получите уникальный API-ключ, он отобразится в соответствующем поле.
25 +
19 19  (% class="box errormessage" %)
20 20  (((
21 21  (% class="wikigeneratedid" id="H41443043D43D44B43943A43B44E44743D43543E43144543E43443843C43E43144343443544243F43544043543443043243044244C43243E43244143544543743043F44043E44143044543E44243243D43544843D43543944143844144243543C44B4322242243E43F430437-WebOffice2243243743043343E43B43E43243A43528header29externalSystemApikey" %)
22 22  (((
23 -**Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey**
30 +=== **Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey** ===
24 24  )))
25 25  )))
26 26  
... ... @@ -54,25 +54,25 @@
54 54  {{code language="javascript" layout="LINENUMBERS"}}
55 55  {
56 56  // идентификатор станции АЗС
57 -string Id
64 +string id
58 58  // статус станции: true – доступна, false – выключена
59 -bool Enable,
66 +bool enable,
60 60  // наименование станции
61 -string Name,
68 +string name,
62 62  // адрес станции
63 -string Address,
70 +string address,
64 64  // гео точка на карте
65 -location Location
72 +location location
66 66  {
67 -double Lat,
68 -double Lon },
74 +double lat,
75 +double lon },
69 69  // словарь доступных ТРК
70 -Dictionary Columns {
77 +Dictionary columns {
71 71  // номер колонки
72 72  (int32) Key:
73 73  {
74 74  // список доступных типов топлива
75 -"Fuels": [ "a92", "a95", "diesel_premium", ... N ]
82 +"fuels": [ "a92", "a95", "diesel_premium", ... N ]
76 76  }
77 77  } ... N
78 78  }
... ... @@ -80,7 +80,8 @@
80 80  
81 81  **Возможные идентификаторы топлива**
82 82  
83 -|ID|Марка
90 +(% border="1" %)
91 +|(% style="background-color:#e5e4e2; border-color:black" %)ID|(% style="background-color:#e5e4e2; border-color:black" %)Марка
84 84  |diesel|дизель
85 85  |diesel_premium|брендированный дизель
86 86  |a80|бензин марки А80
... ... @@ -107,11 +107,13 @@
107 107  {
108 108   {
109 109   // идентификатор станции внутри Топаз "Web Офис"
110 - string StationId,
118 + string stationId,
111 111   // идентификатор топлива
112 - string ProductId,
120 + string productId,
113 113   // цена за 1 литр
114 - double Price
122 + double price
123 + // Внешний код топлива
124 + string fuelExtendedId
115 115   },
116 116  …. N
117 117  }
... ... @@ -121,9 +121,9 @@
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  
... ... @@ -141,10 +141,12 @@
141 141  {
142 142  // Идентификатор заказа
143 143  String Id
144 -// дата и время создания в 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
145 145  String DateCreate
146 146  // идентификатор станции АЗС
147 147  String StationExtendedId
158 +// Идентификатор АЗС в системе Интегратора (Необязательное поле)
159 +String StationId
148 148  // Тип заказа
149 149  String OrderType
150 150  // номер стороны (поста)
... ... @@ -161,7 +161,7 @@
161 161  double SumPaid
162 162  // Статус заказа
163 163  OrderStatus Status
164 -// дата и время завершения заказа 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
165 165  String DateEnd
166 166  // Идентификатор причины отмены заказа
167 167  String ReasonId
... ... @@ -222,6 +222,13 @@
222 222  **FuelId **+ **PriceFuel **– в случае если стоимость топлива в Топаз "Web Офис" отличается от присланной, то Топаз "Web Офис" дает ответ **402.**
223 223  
224 224  
237 +== Отмена заказа ==
238 +
239 +Отмена заказа возможна даже после его старта. Для инициации отмены необходимо отправить тот же заказ со статусом (% style="background-color:#dddddd; font-family:Courier New,Courier,monospace" %)**UserCanceled**(%%). Если на момент получения запроса на отмену процесс налива ещё не начался, заказ будет отменён.
240 +
241 +В случае, если отмена инициирована после начала налива, система остановит процесс пролива и зафиксирует заказ как отменённый. В этом случае в ответе будет указано количество литров, фактически налитых до момента остановки.
242 +
243 +
225 225  == Проверка статуса работы станции ==
226 226  
227 227  Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
... ... @@ -238,8 +238,10 @@
238 238  
239 239  **200 ОК **– станция и ТРК готова принять и обработать заказ
240 240  
241 -**400 **– станция или ТРК не найдена (не верный идентификатор станции или ТРК) **404 **– ТРК занята / ТРК не готова принять заказ
260 +**400 **– станция или ТРК не найдена (неверный идентификатор станции или ТРК)
242 242  
262 +**404 **– ТРК занята / ТРК не готова принять заказ
263 +
243 243  любой ответ не **200 ОК **– интерпретируется как на станции нет интернета / станция не доступна
244 244  
245 245  ----
... ... @@ -252,10 +252,15 @@
252 252  1. **Статус Fueling**
253 253  1. **Статус Canceled**
254 254  1. **Статус Completed**
255 -1. **Отправка счетчика налива**
276 +1. **Отправка счетчика налива Volume**
256 256  
257 257  Данные запросы "Топаз-Web Office" отправляет Интегратору.
258 258  
280 +(% class="box infomessage" %)
281 +(((
282 +##**Все методы, отправляющие статусы заказа (**##**Accepted, Fueling, Canceled, Completed, Volume),## отправляют данные в теле в формате x-www-form-urlencoded##**
283 +)))
284 +
259 259  === **Статус Accepted** ===
260 260  
261 261  Данный статус сообщает внешней системе о том, что заказ принят и обработан в "Топаз-Web Office"
... ... @@ -316,12 +316,16 @@
316 316  
317 317  **baseUrl + /api/order/completed POST**
318 318  
319 -**apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&extendedDate={extendedDate}**
345 +**apikey={apikey}&orderId={ordeId}&litre={litre}&summ={summ}&extendedOrderId={extendedOrderId}&extendedDate={extendedDate}**
320 320  
321 321  все параметры являются обязательными
322 322  
323 -**litre **– кол-во пролитых литров, указывается как **double **с разделителем точка **extendedOrderId **– идентификатор заказа в АСУ сети
349 +**litre **– кол-во пролитых литров, указывается как **double **с разделителем точка,
324 324  
351 +**summ **- итоговая сумма заказа,
352 +
353 +**extendedOrderId **– идентификатор заказа в АСУ сети
354 +
325 325  **extendedDate **– дата по которой АСУ строит отчет для сверки, формат **dd.MM.yyyy HH:mm:ss**
326 326  
327 327  === ===