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

Сводка

Подробности

Свойства страницы
Содержимое
... ... @@ -3,7 +3,7 @@
3 3  == Настройка перед интеграцией ==
4 4  
5 5  
6 -Перед началом интеграции, уполномоченный сотрудник компании, предоставляющей услуги внешних наливов, передает в ООО "Топаз-сервис" следующую информацию:
6 +Перед началом интеграции, уполномоченный сотрудник компании, предоставляющей услуги внешних наливов (далее Интегратор), передает в ООО "Топаз-сервис" следующую информацию:
7 7  
8 8  1. Базовый url тестового окружения системы внешнего налива
9 9  1. Список ip адресов, с которых будут приходить запросы от тестового окружения системы внешнего налива
... ... @@ -14,20 +14,58 @@
14 14  
15 15  После получения информации по указанным пунктам, от ООО "Топаз-сервис" будет предоставлен тестовый доступ для настройки интеграции.
16 16  
17 -Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в Топаз "Web Офис". Данный ключ необходимо будет передавать во всех запросах от внешней системы в Топаз "Web Офис" в заголовке externalSystemApikey
17 +Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в "Топаз-Web Office".
18 18  
19 +(% class="box errormessage" %)
20 +(((
21 +=== **Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey** ===
22 +)))
23 +
24 +== ApiKey ==
25 +
26 +(% class="wikigeneratedid" %)
27 +Интегратору необходимо для каждого своего клиента (сети АЗС) сформировать и хранить в собственной базе данных уникальный Apikey.
28 +С помощью этого Apikey происходит идентификация клиента (сети АЗС) при обмене между "Топаз-Web Office" и системой Интегратора.
29 +
30 +== Адрес для отправки запросов ==
31 +
32 +Базовым адресом **(baseUrl)** для выполнения запросов является [[https:~~/~~/topazoffice.ru/ms/external-fueling/integration>>https://topazoffice.ru/ms/external-fueling/integration]]
33 +
19 19  == Получение списка АЗС и их конфигураций ==
20 20  
21 -Внешняя система опрашивает Топаз "Web Офис" для получения списка АЗС и их конфигураций **через HTTP **запрос на **url **с префиксом **/integration/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
36 +Внешняя система опрашивает "Топаз-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"}}{ // идентификатор станции АЗС 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}}**
42 +{{code language="javascript"}}
43 +{
44 +// идентификатор станции АЗС
45 +string Id
46 +// статус станции: true – доступна, false – выключена
47 +bool Enable,
48 +// наименование станции
49 +string Name,
50 +// адрес станции
51 +string Address,
52 +// гео точка на карте
53 +location Location
54 +{
55 +double Lat,
56 +double Lon },
57 +// словарь доступных ТРК
58 +Dictionary Columns {
59 +// номер колонки
60 +(int32) Key:
61 +{
62 +// список доступных типов топлива
63 +"Fuels": [ "a92", "a95", "diesel_premium", ... N ]
64 +}
65 +} ... N
66 +}
67 +{{/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,26 +47,83 @@
47 47  
48 48  == Получение прайс-листа ==
49 49  
50 -Внешняя система опрашивает Топаз "Web Офис" для получения прайс-листа **HTTP **запросом на **url **с префиксом **/integration/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
88 +Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
51 51  
52 -В ответ Топаз "Web Офис" дает ответ в формате **JSON**
90 +В ответ Топаз "Web Офис" дает ответ в формате **JSON**{{{}}}
53 53  
54 -{{{{ { // идентификатор станции внутри Топаз "Web Офис" string StationId, // идентификатор топлива string ProductId, // цена за 1 литр double Price }, …. N }}}}
92 +{{code language="javascript"}}
93 +{
94 + {
95 + // идентификатор станции внутри Топаз "Web Офис"
96 + string StationId,
97 + // идентификатор топлива
98 + string ProductId,
99 + // цена за 1 литр
100 + double Price
101 + },
102 +…. N
103 +}
104 +{{/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}, }}}}
59 59  
108 +**Пример ответа**{{{}}}
109 +
110 +{{code language="javascript"}}
111 +{
112 +{“StationId”: “0001”, “ProductId”: “a92”, “Price”: 38.66},
113 +{“StationId”: “0001”, “ProductId”: “a95_premium”, “Price”: 45.21},
114 +{“StationId”: “0002”, “ProductId”: “a92”, “Price”: 38.98},
115 +}
116 +{{/code}}
117 +
60 60  == Обработка заказа ==
61 61  
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 секунд.
122 +Информирование "Топаз-Web Office" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
65 65  
66 66  
67 -**Тело запроса содержит JSON вида Order**
125 +**Тело запроса содержит 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 }}}}
127 +{{code language="none"}}
128 +{
129 +// идентификатор заказа
130 +string Id
131 +// дата и время создания в UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
132 +String DateCreate
133 +// значение заказа
134 +double OrderVolume
135 +// идентификатор станции АЗС
136 +string StationExtendedId
137 +// номер колонки
138 +int ColumnId
139 +// идентификатор топлива
140 +string FuelId
141 +// стоимость 1 литра топлива
142 +double PriceFuel
143 +// сумма заказа
144 +double Sum
145 +// кол-во литров
146 +double Litre
147 +// итого оплачено
148 +double SumPaid
149 +// статус заказа
150 +OrderStatus Status
151 +// дата и время завершения заказа UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
152 +String DateEnd
153 +// идентификатор причины отмены заказа
154 +string ReasonId
155 +// причина отмены
156 +string Reason
157 +// итого сумма литров залито
158 +double LitreCompleted
159 +// итого оплачено по завершению заказа
160 +double SumPaidCompleted
161 +// идентификатор договора
162 +string ContractId
163 +}
164 +{{/code}}
70 70  
71 71  Параметр **OrderType **– тип заказа может принимать следующие значения:
72 72  
... ... @@ -96,13 +96,13 @@
96 96  
97 97  === Статус Accept ===
98 98  
99 -Данный статус сообщает внешней системе о том, что заказ принят и обработан в Топаз "Web Офис"
194 +Данный статус сообщает внешней системе о том, что заказ принят и обработан в "Топаз-Web Office"
100 100  
101 -Данный статус Топаз "Web Офис"отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
196 +Данный статус "Топаз-Web Office" отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
102 102  
103 -В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
198 +В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
104 104  
105 -**базовый url + /api/order/accept POST**
200 +**baseUrl + /api/order/accept POST**
106 106  
107 107  **apikey={apikey}&orderId={ordeId}**
108 108  
... ... @@ -110,13 +110,13 @@
110 110  
111 111  === Статус Fueling ===
112 112  
113 -Данный статус сообщает внешней системе о том, что Топаз "Web Офис" готов запустить колонку (начать пролив)
208 +Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
114 114  
115 -Данный статус Топаз "Web Офис" отсылает перед началом пуска колонки
210 +Данный статус "Топаз-Web Office" отсылает перед началом пуска колонки
116 116  
117 -В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
212 +В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
118 118  
119 -**базовый url + /api/order/fueling POST**
214 +**baseUrl + /api/order/fueling POST**
120 120  
121 121  **apikey={apikey}&orderId={ordeId}**
122 122  
... ... @@ -126,7 +126,7 @@
126 126  
127 127  Данный статус сообщает внешней системе о том, что заказ следует отменить
128 128  
129 -**базовый url + /api/order/canceled**
224 +**baseUrl + /api/order/canceled**
130 130  
131 131  **POST**
132 132  
... ... @@ -140,9 +140,9 @@
140 140  
141 141  Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
142 142  
143 -В случае если внешняя система дала ответ отличный от **200 ОК **, то Топаз "Web Офис" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
238 +В случае если внешняя система дала ответ отличный от **200 ОК **, то "Топаз-Web Office" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
144 144  
145 -**базовый url + /api/order/completed POST**
240 +**baseUrl + /api/order/completed POST**
146 146  
147 147  **apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&**
148 148  
... ... @@ -156,11 +156,11 @@
156 156  
157 157  === Отправка счетчика налива ===
158 158  
159 -В момент процесса налива Топаз "Web Офис" может сообщать внешней системе статус счетчика налива
254 +В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива
160 160  
161 -Для этого с периодичностью от 5 – 10 секунд Топаз "Web Офис" выполняет следующий запрос
256 +Для этого с периодичностью от 5 – 10 секунд "Топаз-Web Office" выполняет следующий запрос
162 162  
163 -**базовый url + /api/order/volume**
258 +**baseUrl + /api/order/volume**
164 164  
165 165  **POST**
166 166  
... ... @@ -172,9 +172,9 @@
172 172  
173 173  == Проверка статуса работы станции ==
174 174  
175 -Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ url с префиксом
270 +Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
176 176  
177 -**/integration/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
272 +**/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
178 178  
179 179  **columnId **– идентификатор ТРК
180 180