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

Сводка

Подробности

Свойства страницы
Содержимое
... ... @@ -14,33 +14,52 @@
14 14  
15 15  После получения информации по указанным пунктам, от ООО "Топаз-сервис" будет предоставлен тестовый доступ для настройки интеграции.
16 16  
17 -Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в Топаз "Web Офис". Данный ключ необходимо будет передавать во всех запросах от внешней системы в Топаз "Web Офис" в заголовке externalSystemApikey
17 +Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в Топаз "Web Офис".
18 18  
19 +(% class="box errormessage" %)
20 +(((
21 +Данный ключ необходимо будет передавать во всех запросах от внешней системы в Топаз "Web Офис" в заголовке externalSystemApikey
22 +)))
23 +
24 +== Адрес для отправки запросов ==
25 +
26 +Базовым адресом **(baseUrl)** для выполнения запросов является [[https:~~/~~/topazoffice.ru/ms/external-fueling/integration>>https://topazoffice.ru/ms/external-fueling/integration]]
27 +
19 19  == Получение списка АЗС и их конфигураций ==
20 20  
21 -Внешняя система опрашивает Топаз "Web Офис" для получения списка АЗС и их конфигураций **через HTTP **запрос на **url **с префиксом **/integration/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
30 +Внешняя система опрашивает Топаз "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"}}{
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:
36 +{{code language="javascript"}}
37 +{
38 +// идентификатор станции АЗС
39 +string Id
40 +// статус станции: true – доступна, false – выключена
41 +bool Enable,
42 +// наименование станции
43 +string Name,
44 +// адрес станции
45 +string Address,
46 +// гео точка на карте
47 +location Location
35 35  {
49 +double Lat,
50 +double Lon },
51 +// словарь доступных ТРК
52 +Dictionary Columns {
53 +// номер колонки
54 +(int32) Key:
55 +{
36 36  // список доступных типов топлива
37 37  "Fuels": [ "a92", "a95", "diesel_premium", ... N ]
38 38  }
39 39  } ... N
40 -}{{/code}}**
60 +}
61 +{{/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секунд.
82 +Внешняя система опрашивает Топаз "Web Офис" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
64 64  
65 -В ответ Топаз "Web Офис" дает ответ в формате **JSON**
84 +В ответ Топаз "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 
88 + {
89 + // идентификатор станции внутри Топаз "Web Офис"
90 + string StationId,
91 + // идентификатор топлива
92 + string ProductId,
93 + // цена за 1 литр
94 + double Price
95 + },
96 +…. 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}, }}}}
102 +**Пример ответа**{{{}}}
87 87  
104 +{{code language="javascript"}}
105 +{
106 +{“StationId”: “0001”, “ProductId”: “a92”, “Price”: 38.66},
107 +{“StationId”: “0001”, “ProductId”: “a95_premium”, “Price”: 45.21},
108 +{“StationId”: “0002”, “ProductId”: “a92”, “Price”: 38.98},
109 +}
110 +{{/code}}
111 +
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 секунд.
116 +Информирование Топаз "Web Офис" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
93 93  
94 94  
95 -**Тело запроса содержит JSON вида Order**
119 +**Тело запроса содержит 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 }}}}
121 +{{code language="none"}}
122 +{
123 +// идентификатор заказа
124 +string Id
125 +// дата и время создания в UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
126 +String DateCreate
127 +// значение заказа
128 +double OrderVolume
129 +// идентификатор станции АЗС
130 +string StationExtendedId
131 +// номер колонки
132 +int ColumnId
133 +// идентификатор топлива
134 +string FuelId
135 +// стоимость 1 литра топлива
136 +double PriceFuel
137 +// сумма заказа
138 +double Sum
139 +// кол-во литров
140 +double Litre
141 +// итого оплачено
142 +double SumPaid
143 +// статус заказа
144 +OrderStatus Status
145 +// дата и время завершения заказа UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
146 +String DateEnd
147 +// идентификатор причины отмены заказа
148 +string ReasonId
149 +// причина отмены
150 +string Reason
151 +// итого сумма литров залито
152 +double LitreCompleted
153 +// итого оплачено по завершению заказа
154 +double SumPaidCompleted
155 +// идентификатор договора
156 +string ContractId
157 +}
158 +{{/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**
194 +**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**
208 +**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**
218 +**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**
234 +**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**
252 +**baseUrl + /api/order/volume**
192 192  
193 193  **POST**
194 194  
... ... @@ -200,9 +200,9 @@
200 200  
201 201  == Проверка статуса работы станции ==
202 202  
203 -Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ url с префиксом
264 +Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
204 204  
205 -**/integration/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
266 +**/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
206 206  
207 207  **columnId **– идентификатор ТРК
208 208