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

Сводка

Подробности

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