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

Сводка

Подробности

Свойства страницы
Автор документа
... ... @@ -1,1 +1,1 @@
1 -XWiki.erina_jv
1 +XWiki.erin_ds
Содержимое
... ... @@ -3,7 +3,7 @@
3 3  == Настройка перед интеграцией ==
4 4  
5 5  
6 -Перед началом интеграции, уполномоченный сотрудник компании, предоставляющей услуги внешних наливов, передает в ООО "Топаз-сервис" следующую информацию:
6 +Перед началом интеграции, уполномоченный сотрудник компании, предоставляющей услуги внешних наливов (далее Интегратор), передает в ООО "Топаз-сервис" следующую информацию:
7 7  
8 8  1. Базовый url тестового окружения системы внешнего налива
9 9  1. Список ip адресов, с которых будут приходить запросы от тестового окружения системы внешнего налива
... ... @@ -14,33 +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" 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:
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
35 35  {
55 +double Lat,
56 +double Lon },
57 +// словарь доступных ТРК
58 +Dictionary Columns {
59 +// номер колонки
60 +(int32) Key:
61 +{
36 36  // список доступных типов топлива
37 37  "Fuels": [ "a92", "a95", "diesel_premium", ... N ]
38 38  }
39 39  } ... N
40 -}{{/code}}**
66 +}
67 +{{/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,36 +60,96 @@
60 60  
61 61  == Получение прайс-листа ==
62 62  
63 -Внешняя система опрашивает Топаз "Web Офис" для получения прайс-листа **HTTP **запросом на **url **с префиксом **/integration/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
88 +Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
64 64  
65 -В ответ Топаз "Web Офис" дает ответ в формате **JSON**
90 +В ответ Топаз "Web Офис" дает ответ в формате **JSON**{{{}}}
66 66  
67 -{{{{ { // идентификатор станции внутри Топаз "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}}
68 68  
69 -**Пример ответа**
70 70  
71 -{{{{ {“StationId”: “0001”, “ProductId”: “a92”, “Price”: 38.66}, {“StationId”: “0001”, “ProductId”: “a95_premium”, “Price”: 45.21}, {“StationId”: “0002”, “ProductId”: “a92”, “Price”: 38.98}, }}}}
72 72  
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 +
73 73  == Обработка заказа ==
74 74  
75 75  [[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2]]
76 76  
77 -Информирование Топаз "Web Офис" о заказе и их статусах осуществляется **HTTP **запросом на **url **с префиксом **/integration/order **, запрос типа **POST **, timeout 10 секунд.
122 +Информирование "Топаз-Web Office" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
78 78  
79 79  
80 -**Тело запроса содержит JSON вида Order**
125 +**Тело запроса содержит JSON вида Order**{{{}}}
81 81  
82 -{{{{ // идентификатор заказа 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="javascript"}}
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 +String StationExtendedId
135 +// Тип заказа
136 +String OrderType
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 +String PayType
165 +}
166 +{{/code}}
83 83  
84 84  Параметр **OrderType **– тип заказа может принимать следующие значения:
85 85  
86 -* **Money **– заправка на фиксированную сумму, **OrderVolume **– сумма рублей
87 -* **Liters **– заправка на литры, **OrderVolume **– кол-вол литров
170 +* **Money **– заправка на фиксированную сумму
171 +* **Liters **– заправка на литры
88 88  
89 89  Параметр **Status **– статус заказа может принимать следующие значения
90 90  
91 91  * **OrderCreated **– заказ создан и полностью оплачен
92 -* **Expire **– статус от АЗС не поступил в течение 30 минут
176 +* **Accepted **- АЗС готова начать налив
177 +* **Expired **– статус от АЗС не поступил в течение 30 минут
93 93  * **Completed **– заказа завершен успешно
94 94  * **StationCanceled **– заказ отменен оператором АЗС или же Топаз "Web Офис"
95 95  * **UserCanceled **– заказ отменен пользователем
... ... @@ -107,15 +107,15 @@
107 107  
108 108  == Передача статусов о заказе ==
109 109  
110 -=== Статус Accept ===
195 +=== Статус Accepted ===
111 111  
112 -Данный статус сообщает внешней системе о том, что заказ принят и обработан в Топаз "Web Офис"
197 +Данный статус сообщает внешней системе о том, что заказ принят и обработан в "Топаз-Web Office"
113 113  
114 -Данный статус Топаз "Web Офис"отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
199 +Данный статус "Топаз-Web Office" отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
115 115  
116 -В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
201 +В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
117 117  
118 -**базовый url + /api/order/accept POST**
203 +**baseUrl + /api/order/accept POST**
119 119  
120 120  **apikey={apikey}&orderId={ordeId}**
121 121  
... ... @@ -123,13 +123,13 @@
123 123  
124 124  === Статус Fueling ===
125 125  
126 -Данный статус сообщает внешней системе о том, что Топаз "Web Офис" готов запустить колонку (начать пролив)
211 +Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
127 127  
128 -Данный статус Топаз "Web Офис" отсылает перед началом пуска колонки
213 +Данный статус "Топаз-Web Office" отсылает перед началом пуска колонки
129 129  
130 -В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
215 +В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
131 131  
132 -**базовый url + /api/order/fueling POST**
217 +**baseUrl + /api/order/fueling POST**
133 133  
134 134  **apikey={apikey}&orderId={ordeId}**
135 135  
... ... @@ -139,7 +139,7 @@
139 139  
140 140  Данный статус сообщает внешней системе о том, что заказ следует отменить
141 141  
142 -**базовый url + /api/order/canceled**
227 +**baseUrl + /api/order/canceled**
143 143  
144 144  **POST**
145 145  
... ... @@ -153,9 +153,9 @@
153 153  
154 154  Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
155 155  
156 -В случае если внешняя система дала ответ отличный от **200 ОК **, то Топаз "Web Офис" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
241 +В случае если внешняя система дала ответ отличный от **200 ОК **, то "Топаз-Web Office" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
157 157  
158 -**базовый url + /api/order/completed POST**
243 +**baseUrl + /api/order/completed POST**
159 159  
160 160  **apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&**
161 161  
... ... @@ -169,11 +169,11 @@
169 169  
170 170  === Отправка счетчика налива ===
171 171  
172 -В момент процесса налива Топаз "Web Офис" может сообщать внешней системе статус счетчика налива
257 +В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива
173 173  
174 -Для этого с периодичностью от 5 – 10 секунд Топаз "Web Офис" выполняет следующий запрос
259 +Для этого с периодичностью от 5 – 10 секунд "Топаз-Web Office" выполняет следующий запрос
175 175  
176 -**базовый url + /api/order/volume**
261 +**baseUrl + /api/order/volume**
177 177  
178 178  **POST**
179 179  
... ... @@ -185,9 +185,9 @@
185 185  
186 186  == Проверка статуса работы станции ==
187 187  
188 -Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ url с префиксом
273 +Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
189 189  
190 -**/integration/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
275 +**/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
191 191  
192 192  **columnId **– идентификатор ТРК
193 193