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

Сводка

Подробности

Свойства страницы
Содержимое
... ... @@ -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,36 +14,74 @@
14 14  
15 15  После получения информации по указанным пунктам, от ООО "Топаз-сервис" будет предоставлен тестовый доступ для настройки интеграции.
16 16  
17 -Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в Топаз "Web Офис". Данный ключ необходимо будет передавать во всех запросах от внешней системы в Топаз "Web Офис" в заголовке externalSystemApikey
17 +Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в "Топаз-Web Office".
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 +
19 19  == Получение списка АЗС и их конфигураций ==
20 20  
21 -Внешняя система опрашивает Топаз "Web Офис" для получения списка АЗС и их конфигураций **через HTTP **запрос на **url **с префиксом **/integration/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
48 +Внешняя система опрашивает "Топаз-Web Office" для получения списка АЗС и их конфигураций **через HTTP **запрос на **baseUrl **с префиксом **/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
22 22  
23 23  В ответ Топаз "Web Офис" дает ответ в формате **JSON**
24 24  
25 25  **...**
26 26  
27 -**{{code language="javascript" layout="LINENUMBERS"}}{
28 -// идентификатор станции АЗС string Id
29 -// статус станции: true – доступна, false – выключена bool Enable,
30 -// наименование станции string Name,
31 -// адрес станции string Address,
32 -// гео точка на карте location Location
33 -{ double Lat, double Lon }, // словарь доступных ТРК Dictionary Columns {
34 -// номер колонки (int32) Key:
54 +{{code language="javascript" layout="LINENUMBERS"}}
55 +{
56 +// идентификатор станции АЗС
57 +string Id
58 +// статус станции: true – доступна, false – выключена
59 +bool Enable,
60 +// наименование станции
61 +string Name,
62 +// адрес станции
63 +string Address,
64 +// гео точка на карте
65 +location Location
35 35  {
67 +double Lat,
68 +double Lon },
69 +// словарь доступных ТРК
70 +Dictionary Columns {
71 +// номер колонки
72 +(int32) Key:
73 +{
36 36  // список доступных типов топлива
37 37  "Fuels": [ "a92", "a95", "diesel_premium", ... N ]
38 38  }
39 39  } ... N
40 -}{{/code}}**
78 +}
79 +{{/code}}
41 41  
42 -{{{{ // идентификатор станции АЗС string Id // статус станции: true – доступна, false – выключена bool Enable, // наименование станции string Name, // адрес станции string Address, // гео точка на карте location Location { double Lat, double Lon }, // словарь доступных ТРК Dictionary Columns { // номер колонки (int32) Key: { // список доступных типов топлива "Fuels": [ "a92", "a95", "diesel_premium", ... N ] } } ... N }}}}
43 -
44 44  **Возможные идентификаторы топлива**
45 45  
46 -|ID|Марка
83 +(% border="1" %)
84 +|(% style="background-color:#e5e4e2; border-color:black" %)ID|(% style="background-color:#e5e4e2; border-color:black" %)Марка
47 47  |diesel|дизель
48 48  |diesel_premium|брендированный дизель
49 49  |a80|бензин марки А80
... ... @@ -58,38 +58,117 @@
58 58  |propane|газ пропан
59 59  |metan|метан
60 60  
99 +== ==
100 +
61 61  == Получение прайс-листа ==
62 62  
63 -Внешняя система опрашивает Топаз "Web Офис" для получения прайс-листа **HTTP **запросом на **url **с префиксом **/integration/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
103 +Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
64 64  
65 -В ответ Топаз "Web Офис" дает ответ в формате **JSON**
105 +В ответ Топаз "Web Офис" дает ответ в формате **JSON**{{{}}}
66 66  
67 -{{{{ { // идентификатор станции внутри Топаз "Web Офис" string StationId, // идентификатор топлива string ProductId, // цена за 1 литр double Price }, …. N }}}}
107 +{{code language="javascript" layout="LINENUMBERS"}}
108 +{
109 + {
110 + // идентификатор станции внутри Топаз "Web Офис"
111 + string StationId,
112 + // идентификатор топлива
113 + string ProductId,
114 + // цена за 1 литр
115 + double Price
116 + },
117 +…. N
118 +}
119 +{{/code}}
68 68  
69 -**Пример ответа**
121 +**Пример ответа**{{{}}}
70 70  
71 -{{{{ {“StationId”: “0001”, “ProductId”: “a92”, “Price”: 38.66}, {“StationId”: “0001”, “ProductId”: “a95_premium”, “Price”: 45.21}, {“StationId”: “0002”, “ProductId”: “a92”, “Price”: 38.98}, }}}}
123 +{{code language="javascript"}}
124 +{
125 +{"StationId": "0001", "ProductId": "a92", "Price": 38.66},
126 +{"StationId": "0001", "ProductId": "a95_premium", "Price": 45.21},
127 +{"StationId": "0002", "ProductId": "a92", "Price": 38.98},
128 +}
129 +{{/code}}
72 72  
73 -== Обработка заказа ==
131 +== ==
74 74  
75 -[[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2]]
133 +== Получение и обработка заказа ==
76 76  
77 -Информирование Топаз "Web Офис" о заказе и их статусах осуществляется **HTTP **запросом на **url **с префиксом **/integration/order **, запрос типа **POST **, timeout 10 секунд.
135 +[[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"]]
78 78  
137 +Информирование "Топаз-Web Office" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
79 79  
80 -**Тело запроса содержит JSON вида Order**
139 +**Тело запроса содержит JSON вида Order{{{}}}**
81 81  
82 -{{{{ // идентификатор заказа 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 }}}}
141 +{{code language="javascript" layout="LINENUMBERS"}}
142 +{
143 +// Идентификатор заказа
144 +String Id
145 +// дата и время создания в UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
146 +String DateCreate
147 +// идентификатор станции АЗС
148 +String StationExtendedId
149 +// Тип заказа
150 +String OrderType
151 +// номер стороны (поста)
152 +int ColumnId
153 +// Идентификатор топлива
154 +String FuelId
155 +// Стоимость 1 литра топлива
156 +double PriceFuel
157 +// Сумма заказа
158 +double Sum
159 +// Размер заказа в литрах
160 +double Litre
161 +// Итого оплачено
162 +double SumPaid
163 +// Статус заказа
164 +OrderStatus Status
165 +// дата и время завершения заказа UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
166 +String DateEnd
167 +// Идентификатор причины отмены заказа
168 +String ReasonId
169 +// Причина отмены
170 +String Reason
171 +// Итого заправлено
172 +double LitreCompleted
173 +// Итого оплачено по завершению заказа
174 +double SumPaidCompleted
175 +// Идентификатор договора
176 +String ContractId
177 +// Способ оплаты
178 +String PayType
179 +}
180 +{{/code}}
83 83  
182 +**Обязательными полями при создании нового заказа являются:**
183 +
184 +{{code layout="LINENUMBERS" language="javascript"}}
185 +{
186 + "Id": "string",
187 + "DateCreate": "string",
188 + "OrderType": "Money",
189 + "StationExtendedId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
190 + "ColumnId": 0,
191 + "FuelId": "diesel"
192 + "PriceFuel": 0,
193 + "Sum": 0,
194 + "Litre": 0,
195 + "Status": "OrderCreated"
196 + "ContractId": "string"
197 +}
198 +{{/code}}
199 +
84 84  Параметр **OrderType **– тип заказа может принимать следующие значения:
85 85  
86 -* **Money **– заправка на фиксированную сумму, **OrderVolume **– сумма рублей
87 -* **Liters **– заправка на литры, **OrderVolume **– кол-вол литров
202 +* **Money **– заправка на фиксированную сумму
203 +* **Liters **– заправка на литры
88 88  
89 89  Параметр **Status **– статус заказа может принимать следующие значения
90 90  
91 91  * **OrderCreated **– заказ создан и полностью оплачен
92 -* **Expire **– статус от АЗС не поступил в течение 30 минут
208 +* **Accepted **- АЗС готова начать налив
209 +* **Expired **– статус от АЗС не поступил в течение 30 минут
93 93  * **Completed **– заказа завершен успешно
94 94  * **StationCanceled **– заказ отменен оператором АЗС или же Топаз "Web Офис"
95 95  * **UserCanceled **– заказ отменен пользователем
... ... @@ -103,43 +103,86 @@
103 103  
104 104  При получении заказа в статусе **OrderCreated **Топаз "Web Офис" проверяет ряд параметров **StationExtendedId **– в случае если идентификатор станции не найден в Топаз "Web Офис", то Топаз "Web Офис" дает ответ **400**
105 105  
106 -**FuelId **+ **PriceFuel **– в случае если стоимость топлива в Топаз "Web Офис" отличается от присланной, то Топаз "Web Офис" дает ответ **402**
223 +**FuelId **+ **PriceFuel **– в случае если стоимость топлива в Топаз "Web Офис" отличается от присланной, то Топаз "Web Офис" дает ответ **402.**
107 107  
108 -== Передача статусов о заказе ==
109 109  
110 -=== Статус Accept ===
226 +== Проверка статуса работы станции ==
111 111  
112 -Данный статус сообщает внешней системе о том, что заказ принят и обработан в Топаз "Web Офис"
228 +Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
113 113  
114 -Данный статус Топаз "Web Офис"отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
230 +**/ping?apikey={apikey}&stationId={stationId}&columnId={columnId},**
115 115  
116 -В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
232 +**stationId **– идентификатор станции
117 117  
118 -**базовый url + /api/order/accept POST**
234 +**columnId **– идентификатор стороны ТРК
119 119  
236 +запрос типа **GET **, timeout 10 секунд.
237 +
238 +==== **Статусы ответов** ====
239 +
240 +**200 ОК **– станция и ТРК готова принять и обработать заказ
241 +
242 +**400 **– станция или ТРК не найдена (неверный идентификатор станции или ТРК)
243 +
244 +**404 **– ТРК занята / ТРК не готова принять заказ
245 +
246 +любой ответ не **200 ОК **– интерпретируется как на станции нет интернета / станция не доступна
247 +
248 +----
249 +
250 +Для получения статусов Интегратору необходимо со своей стороны реализовать сервис для их получения и обработки.
251 +
252 +== **Методы REST API интегратора (внешней системы):** ==
253 +
254 +1. **Статус Accepted**
255 +1. **Статус Fueling**
256 +1. **Статус Canceled**
257 +1. **Статус Completed**
258 +1. **Отправка счетчика налива**
259 +
260 +Данные запросы "Топаз-Web Office" отправляет Интегратору.
261 +
262 +=== **Статус Accepted** ===
263 +
264 +Данный статус сообщает внешней системе о том, что заказ принят и обработан в "Топаз-Web Office"
265 +
266 +Данный статус "Топаз-Web Office" отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
267 +
268 +В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
269 +
270 +**baseUrl + /api/order/accept**
271 +
272 +**POST**
273 +
120 120  **apikey={apikey}&orderId={ordeId}**
121 121  
122 122  все параметры являются обязательными
123 123  
124 -=== Статус Fueling ===
278 +=== ===
125 125  
126 -Данный статус сообщает внешней системе о том, что Топаз "Web Офис" готов запустить колонку (начать пролив)
280 +=== **Статус Fueling** ===
127 127  
128 -Данный статус Топаз "Web Офис" отсылает перед началом пуска колонки
282 +Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
129 129  
130 -В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
284 +Данный статус "Топаз-Web Office" отсылает перед началом пуска колонки
131 131  
132 -**базовый url + /api/order/fueling POST**
286 +В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
133 133  
288 +**baseUrl + /api/order/fueling**
289 +
290 +**POST**
291 +
134 134  **apikey={apikey}&orderId={ordeId}**
135 135  
136 136  все параметры являются обязательными
137 137  
138 -=== Статус Canceled ===
296 +=== ===
139 139  
298 +=== **Статус Canceled** ===
299 +
140 140  Данный статус сообщает внешней системе о том, что заказ следует отменить
141 141  
142 -**базовый url + /api/order/canceled**
302 +**baseUrl + /api/order/canceled**
143 143  
144 144  **POST**
145 145  
... ... @@ -149,18 +149,18 @@
149 149  
150 150  **reason – **текстовая причина отмены
151 151  
152 -=== Статус Completed ===
312 +=== ===
153 153  
314 +=== **Статус Completed** ===
315 +
154 154  Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
155 155  
156 -В случае если внешняя система дала ответ отличный от **200 ОК **, то Топаз "Web Офис" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
318 +В случае если внешняя система дала ответ отличный от **200 ОК **, то "Топаз-Web Office" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
157 157  
158 -**базовый url + /api/order/completed POST**
320 +**baseUrl + /api/order/completed POST**
159 159  
160 -**apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&**
322 +**apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&extendedDate={extendedDate}**
161 161  
162 -**extendedDate={extendedDate}**
163 -
164 164  все параметры являются обязательными
165 165  
166 166  **litre **– кол-во пролитых литров, указывается как **double **с разделителем точка **extendedOrderId **– идентификатор заказа в АСУ сети
... ... @@ -167,14 +167,16 @@
167 167  
168 168  **extendedDate **– дата по которой АСУ строит отчет для сверки, формат **dd.MM.yyyy HH:mm:ss**
169 169  
170 -=== Отправка счетчика налива ===
330 +=== ===
171 171  
172 -В момент процесса налива Топаз "Web Офис" может сообщать внешней системе статус счетчика налива
332 +=== **Отправка счетчика налива** ===
173 173  
174 -Для этого с периодичностью от 5 – 10 секунд Топаз "Web Офис" выполняет следующий запрос
334 +В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива
175 175  
176 -**базовый url + /api/order/volume**
336 +Для этого с периодичностью от 5 – 10 секунд "Топаз-Web Office" выполняет следующий запрос
177 177  
338 +**baseUrl + /api/order/volume**
339 +
178 178  **POST**
179 179  
180 180  **apikey={apikey}&orderId={ordeId}&litre={litre}**
... ... @@ -182,21 +182,3 @@
182 182  все параметры являются обязательными
183 183  
184 184  **litre **– кол-во пролитых на момент отправки запроса литров, указывается как double с разделителем точка
185 -
186 -== Проверка статуса работы станции ==
187 -
188 -Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ url с префиксом
189 -
190 -**/integration/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
191 -
192 -**columnId **– идентификатор ТРК
193 -
194 -запрос типа **GET **, timeout 10 секунд.
195 -
196 -== Статусы ответов ==
197 -
198 -**200 ОК **– станция и ТРК готова принять и обработать заказ
199 -
200 -**400 **– станция или ТРК не найдена (не верный идентификатор станции или ТРК) **404 **– ТРК занята / ТРК не готова принять заказ
201 -
202 -любой ответ не **200 ОК **– интерпретируется как на станции нет интернета / станция не доступна