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

Сводка

Подробности

Свойства страницы
Содержимое
... ... @@ -16,31 +16,45 @@
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  
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:
31 +{{code language="javascript"}}
32 +{
33 +// идентификатор станции АЗС
34 +string Id
35 +// статус станции: true – доступна, false – выключена
36 +bool Enable,
37 +// наименование станции
38 +string Name,
39 +// адрес станции
40 +string Address,
41 +// гео точка на карте
42 +location Location
35 35  {
44 +double Lat,
45 +double Lon },
46 +// словарь доступных ТРК
47 +Dictionary Columns {
48 +// номер колонки
49 +(int32) Key:
50 +{
36 36  // список доступных типов топлива
37 37  "Fuels": [ "a92", "a95", "diesel_premium", ... N ]
38 38  }
39 39  } ... N
40 -}{{/code}}**
55 +}
56 +{{/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,41 +60,83 @@
60 60  
61 61  == Получение прайс-листа ==
62 62  
63 -Внешняя система опрашивает Топаз "Web Офис" для получения прайс-листа **HTTP **запросом на **url **с префиксом **/integration/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
77 +Внешняя система опрашивает Топаз "Web Офис" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
64 64  
65 -В ответ Топаз "Web Офис" дает ответ в формате **JSON**
79 +В ответ Топаз "Web Офис" дает ответ в формате **JSON**{{{}}}
66 66  
67 -{{{{ { // идентификатор станции внутри Топаз "Web Офис" string StationId, // идентификатор топлива string ProductId, // цена за 1 литр double Price }, …. N }}}}
68 -
69 -
70 70  {{code language="javascript"}}
71 71  {
72 -{
73 -// идентификатор станции внутри Топаз "Web Офис"
74 -string StationId, 
75 -// идентификатор топлива 
76 -string ProductId, 
77 -// цена за 1 литр 
78 -double Price 
79 -}, …. N 
83 + {
84 + // идентификатор станции внутри Топаз "Web Офис"
85 + string StationId,
86 + // идентификатор топлива
87 + string ProductId,
88 + // цена за 1 литр
89 + double Price
90 + },
91 +…. N
80 80  }
81 81  {{/code}}
82 82  
83 83  
84 -**Пример ответа**
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}, }}}}
97 +**Пример ответа**{{{}}}
87 87  
99 +{{code language="javascript"}}
100 +{
101 +{“StationId”: “0001”, “ProductId”: “a92”, “Price”: 38.66},
102 +{“StationId”: “0001”, “ProductId”: “a95_premium”, “Price”: 45.21},
103 +{“StationId”: “0002”, “ProductId”: “a92”, “Price”: 38.98},
104 +}
105 +{{/code}}
106 +
88 88  == Обработка заказа ==
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 секунд.
111 +Информирование Топаз "Web Офис" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
93 93  
94 94  
95 -**Тело запроса содержит JSON вида Order**
114 +**Тело запроса содержит 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 }}}}
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}}
98 98  
99 99  Параметр **OrderType **– тип заказа может принимать следующие значения:
100 100  
... ... @@ -130,7 +130,7 @@
130 130  
131 131  В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
132 132  
133 -**базовый url + /api/order/accept POST**
189 +**baseUrl + /api/order/accept POST**
134 134  
135 135  **apikey={apikey}&orderId={ordeId}**
136 136  
... ... @@ -144,7 +144,7 @@
144 144  
145 145  В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
146 146  
147 -**базовый url + /api/order/fueling POST**
203 +**baseUrl + /api/order/fueling POST**
148 148  
149 149  **apikey={apikey}&orderId={ordeId}**
150 150  
... ... @@ -154,7 +154,7 @@
154 154  
155 155  Данный статус сообщает внешней системе о том, что заказ следует отменить
156 156  
157 -**базовый url + /api/order/canceled**
213 +**baseUrl + /api/order/canceled**
158 158  
159 159  **POST**
160 160  
... ... @@ -170,7 +170,7 @@
170 170  
171 171  В случае если внешняя система дала ответ отличный от **200 ОК **, то Топаз "Web Офис" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
172 172  
173 -**базовый url + /api/order/completed POST**
229 +**baseUrl + /api/order/completed POST**
174 174  
175 175  **apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&**
176 176  
... ... @@ -188,7 +188,7 @@
188 188  
189 189  Для этого с периодичностью от 5 – 10 секунд Топаз "Web Офис" выполняет следующий запрос
190 190  
191 -**базовый url + /api/order/volume**
247 +**baseUrl + /api/order/volume**
192 192  
193 193  **POST**
194 194  
... ... @@ -200,9 +200,9 @@
200 200  
201 201  == Проверка статуса работы станции ==
202 202  
203 -Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ url с префиксом
259 +Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
204 204  
205 -**/integration/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
261 +**/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
206 206  
207 207  **columnId **– идентификатор ТРК
208 208