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

Сводка

Подробности

Свойства страницы
Содержимое
... ... @@ -1,9 +1,11 @@
1 -====== **v 1.0.1** ======
1 +{{toc/}}
2 2  
3 +v 1.0.1
4 +
3 3  == Настройка перед интеграцией ==
4 4  
5 5  
6 -Перед началом интеграции, уполномоченный сотрудник компании, предоставляющей услуги внешних наливов, передает в ООО "Топаз-сервис" следующую информацию:
8 +Перед началом интеграции, уполномоченный сотрудник компании, предоставляющей услуги внешних наливов (далее Интегратор), передает в ООО "Топаз-сервис" следующую информацию:
7 7  
8 8  1. Базовый url тестового окружения системы внешнего налива
9 9  1. Список ip адресов, с которых будут приходить запросы от тестового окружения системы внешнего налива
... ... @@ -14,20 +14,66 @@
14 14  
15 15  После получения информации по указанным пунктам, от ООО "Топаз-сервис" будет предоставлен тестовый доступ для настройки интеграции.
16 16  
17 -Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в Топаз "Web Офис". Данный ключ необходимо будет передавать во всех запросах от внешней системы в Топаз "Web Офис" в заголовке externalSystemApikey
19 +Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в "Топаз-Web Office".
18 18  
21 +(% class="box errormessage" %)
22 +(((
23 +=== **Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey** ===
24 +)))
25 +
26 +== ApiKey ==
27 +
28 +(% class="wikigeneratedid" %)
29 +Интегратору необходимо для каждого своего клиента (сети АЗС) сформировать и хранить в собственной базе данных уникальный Apikey.
30 +С помощью этого Apikey происходит идентификация клиента (сети АЗС) при обмене между "Топаз-Web Office" и системой Интегратора.
31 +
32 +== Адрес для отправки запросов ==
33 +
34 +Базовым адресом **(baseUrl)** для выполнения запросов является [[https:~~/~~/topazoffice.ru/ms/external-fueling/integration>>https://topazoffice.ru/ms/external-fueling/integration]]
35 +
36 +
37 +== **Методы API "Топаз-Web Office":** ==
38 +
39 +1. **Получение списка АЗС и их конфигураций**
40 +1. **Получение прайс-листа**
41 +1. **Получение и обработка заказа**
42 +1. **Проверка статуса работы станции**
43 +
19 19  == Получение списка АЗС и их конфигураций ==
20 20  
21 -Внешняя система опрашивает Топаз "Web Офис" для получения списка АЗС и их конфигураций **через HTTP **запрос на **url **с префиксом **/integration/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
46 +Внешняя система опрашивает "Топаз-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"}}{ // идентификатор станции АЗС 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 }{{/code}}**
52 +{{code language="javascript" layout="LINENUMBERS"}}
53 +{
54 +// идентификатор станции АЗС
55 +string Id
56 +// статус станции: true – доступна, false – выключена
57 +bool Enable,
58 +// наименование станции
59 +string Name,
60 +// адрес станции
61 +string Address,
62 +// гео точка на карте
63 +location Location
64 +{
65 +double Lat,
66 +double Lon },
67 +// словарь доступных ТРК
68 +Dictionary Columns {
69 +// номер колонки
70 +(int32) Key:
71 +{
72 +// список доступных типов топлива
73 +"Fuels": [ "a92", "a95", "diesel_premium", ... N ]
74 +}
75 +} ... N
76 +}
77 +{{/code}}
28 28  
29 -{{{{ // идентификатор станции АЗС 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 }}}}
30 -
31 31  **Возможные идентификаторы топлива**
32 32  
33 33  |ID|Марка
... ... @@ -47,36 +47,113 @@
47 47  
48 48  == Получение прайс-листа ==
49 49  
50 -Внешняя система опрашивает Топаз "Web Офис" для получения прайс-листа **HTTP **запросом на **url **с префиксом **/integration/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
98 +Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
51 51  
52 -В ответ Топаз "Web Офис" дает ответ в формате **JSON**
100 +В ответ Топаз "Web Офис" дает ответ в формате **JSON**{{{}}}
53 53  
54 -{{{{ { // идентификатор станции внутри Топаз "Web Офис" string StationId, // идентификатор топлива string ProductId, // цена за 1 литр double Price }, …. N }}}}
102 +{{code language="javascript" layout="LINENUMBERS"}}
103 +{
104 + {
105 + // идентификатор станции внутри Топаз "Web Офис"
106 + string StationId,
107 + // идентификатор топлива
108 + string ProductId,
109 + // цена за 1 литр
110 + double Price
111 + },
112 +…. N
113 +}
114 +{{/code}}
55 55  
56 -**Пример ответа**
57 57  
58 -{{{{ {“StationId”: “0001”, “ProductId”: “a92”, “Price”: 38.66}, {“StationId”: “0001”, “ProductId”: “a95_premium”, “Price”: 45.21}, {“StationId”: “0002”, “ProductId”: “a92”, “Price”: 38.98}, }}}}
117 +**Пример ответа**{{{}}}
59 59  
60 -== Обработка заказа ==
119 +{{code language="javascript"}}
120 +{
121 +{"StationId": "0001", "ProductId": "a92", "Price": 38.66},
122 +{"StationId": "0001", "ProductId": "a95_premium", "Price": 45.21},
123 +{"StationId": "0002", "ProductId": "a92", "Price": 38.98},
124 +}
125 +{{/code}}
61 61  
127 +== Получение и обработка заказа ==
128 +
62 62  [[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2]]
63 63  
64 -Информирование Топаз "Web Офис" о заказе и их статусах осуществляется **HTTP **запросом на **url **с префиксом **/integration/order **, запрос типа **POST **, timeout 10 секунд.
131 +Информирование "Топаз-Web Office" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
65 65  
66 66  
67 -**Тело запроса содержит JSON вида Order**
134 +**Тело запроса содержит JSON вида Order{{{}}}**
68 68  
69 -{{{{ // идентификатор заказа 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 }}}}
136 +{{code language="javascript" layout="LINENUMBERS"}}
137 +{
138 +// Идентификатор заказа
139 +String Id
140 +// дата и время создания в UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
141 +String DateCreate
142 +// идентификатор станции АЗС
143 +String StationExtendedId
144 +// Тип заказа
145 +String OrderType
146 +// номер стороны (поста)
147 +int ColumnId
148 +// Идентификатор топлива
149 +String FuelId
150 +// Стоимость 1 литра топлива
151 +double PriceFuel
152 +// Сумма заказа
153 +double Sum
154 +// Размер заказа в литрах
155 +double Litre
156 +// Итого оплачено
157 +double SumPaid
158 +// Статус заказа
159 +OrderStatus Status
160 +// дата и время завершения заказа UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
161 +String DateEnd
162 +// Идентификатор причины отмены заказа
163 +String ReasonId
164 +// Причина отмены
165 +String Reason
166 +// Итого заправлено
167 +double LitreCompleted
168 +// Итого оплачено по завершению заказа
169 +double SumPaidCompleted
170 +// Идентификатор договора
171 +String ContractId
172 +// Способ оплаты
173 +String PayType
174 +}
175 +{{/code}}
70 70  
177 +**Обязательными полями при создании нового заказа являются:**
178 +
179 +{{code layout="LINENUMBERS" language="javascript"}}
180 +{
181 + "Id": "string",
182 + "DateCreate": "string",
183 + "OrderType": "Money",
184 + "StationExtendedId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
185 + "ColumnId": 0,
186 + "FuelId": "diesel"
187 + "PriceFuel": 0,
188 + "Sum": 0,
189 + "Litre": 0,
190 + "Status": "OrderCreated"
191 + "ContractId": "string"
192 +}
193 +{{/code}}
194 +
71 71  Параметр **OrderType **– тип заказа может принимать следующие значения:
72 72  
73 -* **Money **– заправка на фиксированную сумму, **OrderVolume **– сумма рублей
74 -* **Liters **– заправка на литры, **OrderVolume **– кол-вол литров
197 +* **Money **– заправка на фиксированную сумму
198 +* **Liters **– заправка на литры
75 75  
76 76  Параметр **Status **– статус заказа может принимать следующие значения
77 77  
78 78  * **OrderCreated **– заказ создан и полностью оплачен
79 -* **Expire **– статус от АЗС не поступил в течение 30 минут
203 +* **Accepted **- АЗС готова начать налив
204 +* **Expired **– статус от АЗС не поступил в течение 30 минут
80 80  * **Completed **– заказа завершен успешно
81 81  * **StationCanceled **– заказ отменен оператором АЗС или же Топаз "Web Офис"
82 82  * **UserCanceled **– заказ отменен пользователем
... ... @@ -90,43 +90,80 @@
90 90  
91 91  При получении заказа в статусе **OrderCreated **Топаз "Web Офис" проверяет ряд параметров **StationExtendedId **– в случае если идентификатор станции не найден в Топаз "Web Офис", то Топаз "Web Офис" дает ответ **400**
92 92  
93 -**FuelId **+ **PriceFuel **– в случае если стоимость топлива в Топаз "Web Офис" отличается от присланной, то Топаз "Web Офис" дает ответ **402**
218 +**FuelId **+ **PriceFuel **– в случае если стоимость топлива в Топаз "Web Офис" отличается от присланной, то Топаз "Web Офис" дает ответ **402.**
94 94  
95 -== Передача статусов о заказе ==
96 96  
97 -=== Статус Accept ===
221 +== Проверка статуса работы станции ==
98 98  
99 -Данный статус сообщает внешней системе о том, что заказ принят и обработан в Топаз "Web Офис"
223 +Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
100 100  
101 -Данный статус Топаз "Web Офис"отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
225 +**/ping?apikey={apikey}&stationId={stationId}&columnId={columnId},**
102 102  
103 -В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
227 +**stationId **– идентификатор станции
104 104  
105 -**базовый url + /api/order/accept POST**
229 +**columnId **– идентификатор стороны ТРК
106 106  
231 +запрос типа **GET **, timeout 10 секунд.
232 +
233 +==== **Статусы ответов** ====
234 +
235 +**200 ОК **– станция и ТРК готова принять и обработать заказ
236 +
237 +**400 **– станция или ТРК не найдена (не верный идентификатор станции или ТРК) **404 **– ТРК занята / ТРК не готова принять заказ
238 +
239 +любой ответ не **200 ОК **– интерпретируется как на станции нет интернета / станция не доступна
240 +
241 +----
242 +
243 +Для получения статусов Интегратору необходимо со своей стороны реализовать сервис для их получения и обработки.
244 +
245 +== **Методы REST API интегратора (внешней системы):** ==
246 +
247 +1. **Статус Accepted**
248 +1. **Статус Fueling**
249 +1. **Статус Canceled**
250 +1. **Статус Completed**
251 +1. **Отправка счетчика налива**
252 +
253 +Данные запросы "Топаз-Web Office" отправляет Интегратору.
254 +
255 +=== **Статус Accepted** ===
256 +
257 +Данный статус сообщает внешней системе о том, что заказ принят и обработан в "Топаз-Web Office"
258 +
259 +Данный статус "Топаз-Web Office" отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
260 +
261 +В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
262 +
263 +**baseUrl + /api/order/accept**
264 +
265 +**POST**
266 +
107 107  **apikey={apikey}&orderId={ordeId}**
108 108  
109 109  все параметры являются обязательными
110 110  
111 -=== Статус Fueling ===
271 +=== **Статус Fueling** ===
112 112  
113 -Данный статус сообщает внешней системе о том, что Топаз "Web Офис" готов запустить колонку (начать пролив)
273 +Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
114 114  
115 -Данный статус Топаз "Web Офис" отсылает перед началом пуска колонки
275 +Данный статус "Топаз-Web Office" отсылает перед началом пуска колонки
116 116  
117 -В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
277 +В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
118 118  
119 -**базовый url + /api/order/fueling POST**
279 +**baseUrl + /api/order/fueling**
120 120  
281 +**POST**
282 +
121 121  **apikey={apikey}&orderId={ordeId}**
122 122  
123 123  все параметры являются обязательными
124 124  
125 -=== Статус Canceled ===
287 +=== **Статус Canceled** ===
126 126  
127 127  Данный статус сообщает внешней системе о том, что заказ следует отменить
128 128  
129 -**базовый url + /api/order/canceled**
291 +**baseUrl + /api/order/canceled**
130 130  
131 131  **POST**
132 132  
... ... @@ -136,18 +136,16 @@
136 136  
137 137  **reason – **текстовая причина отмены
138 138  
139 -=== Статус Completed ===
301 +=== **Статус Completed** ===
140 140  
141 141  Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
142 142  
143 -В случае если внешняя система дала ответ отличный от **200 ОК **, то Топаз "Web Офис" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
305 +В случае если внешняя система дала ответ отличный от **200 ОК **, то "Топаз-Web Office" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
144 144  
145 -**базовый url + /api/order/completed POST**
307 +**baseUrl + /api/order/completed POST**
146 146  
147 -**apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&**
309 +**apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&extendedDate={extendedDate}**
148 148  
149 -**extendedDate={extendedDate}**
150 -
151 151  все параметры являются обязательными
152 152  
153 153  **litre **– кол-во пролитых литров, указывается как **double **с разделителем точка **extendedOrderId **– идентификатор заказа в АСУ сети
... ... @@ -154,13 +154,13 @@
154 154  
155 155  **extendedDate **– дата по которой АСУ строит отчет для сверки, формат **dd.MM.yyyy HH:mm:ss**
156 156  
157 -=== Отправка счетчика налива ===
317 +=== **Отправка счетчика налива** ===
158 158  
159 -В момент процесса налива Топаз "Web Офис" может сообщать внешней системе статус счетчика налива
319 +В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива
160 160  
161 -Для этого с периодичностью от 5 – 10 секунд Топаз "Web Офис" выполняет следующий запрос
321 +Для этого с периодичностью от 5 – 10 секунд "Топаз-Web Office" выполняет следующий запрос
162 162  
163 -**базовый url + /api/order/volume**
323 +**baseUrl + /api/order/volume**
164 164  
165 165  **POST**
166 166  
... ... @@ -169,21 +169,3 @@
169 169  все параметры являются обязательными
170 170  
171 171  **litre **– кол-во пролитых на момент отправки запроса литров, указывается как double с разделителем точка
172 -
173 -== Проверка статуса работы станции ==
174 -
175 -Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ url с префиксом
176 -
177 -**/integration/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
178 -
179 -**columnId **– идентификатор ТРК
180 -
181 -запрос типа **GET **, timeout 10 секунд.
182 -
183 -== Статусы ответов ==
184 -
185 -**200 ОК **– станция и ТРК готова принять и обработать заказ
186 -
187 -**400 **– станция или ТРК не найдена (не верный идентификатор станции или ТРК) **404 **– ТРК занята / ТРК не готова принять заказ
188 -
189 -любой ответ не **200 ОК **– интерпретируется как на станции нет интернета / станция не доступна