Перейти к содержимому
Редактировал(а) Dmitriy 2026/04/23 06:18
От версии 12.1
отредактировано Ярослава Ерина
на 2024/07/30 06:31
Изменить комментарий: К данной версии нет комментариев
К версии 17.1
отредактировано Ярослава Ерина
на 2024/09/18 06:46
Изменить комментарий: К данной версии нет комментариев

Сводка

Подробности

Свойства страницы
Содержимое
... ... @@ -16,9 +16,13 @@
16 16  
17 17  Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в Топаз "Web Офис". Данный ключ необходимо будет передавать во всех запросах от внешней системы в Топаз "Web Офис" в заголовке externalSystemApikey
18 18  
19 +== Адрес для отправки запросов ==
20 +
21 +Базовым адресом **(baseUrl)** для выполнения запросов является [[https:~~/~~/topazoffice.ru/ms/external-fueling/integration>>https://topazoffice.ru/ms/external-fueling/integration]]
22 +
19 19  == Получение списка АЗС и их конфигураций ==
20 20  
21 -Внешняя система опрашивает Топаз "Web Офис" для получения списка АЗС и их конфигураций **через HTTP **запрос на **url **с префиксом **/integration/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
25 +Внешняя система опрашивает Топаз "Web Офис" для получения списка АЗС и их конфигураций **через HTTP **запрос на **baseUrl **с префиксом **/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
22 22  
23 23  В ответ Топаз "Web Офис" дает ответ в формате **JSON**
24 24  
... ... @@ -70,7 +70,7 @@
70 70  
71 71  == Получение прайс-листа ==
72 72  
73 -Внешняя система опрашивает Топаз "Web Офис" для получения прайс-листа **HTTP **запросом на **url **с префиксом **/integration/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
77 +Внешняя система опрашивает Топаз "Web Офис" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
74 74  
75 75  В ответ Топаз "Web Офис" дает ответ в формате **JSON**{{{}}}
76 76  
... ... @@ -89,20 +89,7 @@
89 89  {{/code}}
90 90  
91 91  
92 -{{code language="javascript"}}
93 -{
94 -{
95 -// идентификатор станции внутри Топаз "Web Офис"
96 -string StationId, 
97 -// идентификатор топлива 
98 -string ProductId, 
99 -// цена за 1 литр 
100 -double Price 
101 -}, …. N 
102 -}
103 -{{/code}}
104 104  
105 -
106 106  **Пример ответа**{{{}}}
107 107  
108 108  {{code language="javascript"}}
... ... @@ -117,12 +117,49 @@
117 117  
118 118  [[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2]]
119 119  
120 -Информирование Топаз "Web Офис" о заказе и их статусах осуществляется **HTTP **запросом на **url **с префиксом **/integration/order **, запрос типа **POST **, timeout 10 секунд.
111 +Информирование Топаз "Web Офис" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
121 121  
122 122  
123 -**Тело запроса содержит JSON вида Order**
114 +**Тело запроса содержит JSON вида Order**{{{}}}
124 124  
125 -{{{{ // идентификатор заказа 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 }}}}
116 +{{code language="none"}}
117 +{
118 +// идентификатор заказа
119 +string Id
120 +// дата и время создания в UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
121 +String DateCreate
122 +// значение заказа
123 +double OrderVolume
124 +// идентификатор станции АЗС
125 +string StationExtendedId
126 +// номер колонки
127 +int ColumnId
128 +// идентификатор топлива
129 +string FuelId
130 +// стоимость 1 литра топлива
131 +double PriceFuel
132 +// сумма заказа
133 +double Sum
134 +// кол-во литров
135 +double Litre
136 +// итого оплачено
137 +double SumPaid
138 +// статус заказа
139 +OrderStatus Status
140 +// дата и время завершения заказа UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
141 +String DateEnd
142 +// идентификатор причины отмены заказа
143 +string ReasonId
144 +// причина отмены
145 +string Reason
146 +// итого сумма литров залито
147 +double LitreCompleted
148 +// итого оплачено по завершению заказа
149 +double SumPaidCompleted
150 +// идентификатор договора
151 +string ContractId
152 +}
153 +{{/code}}
126 126  
127 127  Параметр **OrderType **– тип заказа может принимать следующие значения:
128 128  
... ... @@ -158,7 +158,7 @@
158 158  
159 159  В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
160 160  
161 -**базовый url + /api/order/accept POST**
189 +**baseUrl + /api/order/accept POST**
162 162  
163 163  **apikey={apikey}&orderId={ordeId}**
164 164  
... ... @@ -172,7 +172,7 @@
172 172  
173 173  В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
174 174  
175 -**базовый url + /api/order/fueling POST**
203 +**baseUrl + /api/order/fueling POST**
176 176  
177 177  **apikey={apikey}&orderId={ordeId}**
178 178  
... ... @@ -182,7 +182,7 @@
182 182  
183 183  Данный статус сообщает внешней системе о том, что заказ следует отменить
184 184  
185 -**базовый url + /api/order/canceled**
213 +**baseUrl + /api/order/canceled**
186 186  
187 187  **POST**
188 188  
... ... @@ -198,7 +198,7 @@
198 198  
199 199  В случае если внешняя система дала ответ отличный от **200 ОК **, то Топаз "Web Офис" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
200 200  
201 -**базовый url + /api/order/completed POST**
229 +**baseUrl + /api/order/completed POST**
202 202  
203 203  **apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&**
204 204  
... ... @@ -216,7 +216,7 @@
216 216  
217 217  Для этого с периодичностью от 5 – 10 секунд Топаз "Web Офис" выполняет следующий запрос
218 218  
219 -**базовый url + /api/order/volume**
247 +**baseUrl + /api/order/volume**
220 220  
221 221  **POST**
222 222  
... ... @@ -228,9 +228,9 @@
228 228  
229 229  == Проверка статуса работы станции ==
230 230  
231 -Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ url с префиксом
259 +Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
232 232  
233 -**/integration/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
261 +**/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
234 234  
235 235  **columnId **– идентификатор ТРК
236 236