Перейти к содержимому
Редактировал(а) Dmitriy 2026/04/23 06:18
От версии 18.1
отредактировано Ярослава Ерина
на 2024/09/25 08:48
Изменить комментарий: К данной версии нет комментариев
К версии 19.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,13 +14,19 @@
14 14  
15 15  После получения информации по указанным пунктам, от ООО "Топаз-сервис" будет предоставлен тестовый доступ для настройки интеграции.
16 16  
17 -Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в Топаз "Web Офис".
17 +Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в "Топаз-Web Office".
18 18  
19 19  (% class="box errormessage" %)
20 20  (((
21 -Данный ключ необходимо будет передавать во всех запросах от внешней системы в Топаз "Web Офис" в заголовке externalSystemApikey
21 +=== **Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey** ===
22 22  )))
23 23  
24 +=== ApiKey ===
25 +
26 +(% class="wikigeneratedid" %)
27 +Интегратору необходимо для каждого своего клиента (сети АЗС) сформировать и хранить в собственной базе данных уникальный Apikey.
28 +С помощью этого Apikey происходит идентификация клиента (сети АЗС) при обмене между "Топаз-Web Office" и системой Интегратора.
29 +
24 24  == Адрес для отправки запросов ==
25 25  
26 26  Базовым адресом **(baseUrl)** для выполнения запросов является [[https:~~/~~/topazoffice.ru/ms/external-fueling/integration>>https://topazoffice.ru/ms/external-fueling/integration]]
... ... @@ -27,7 +27,7 @@
27 27  
28 28  == Получение списка АЗС и их конфигураций ==
29 29  
30 -Внешняя система опрашивает Топаз "Web Офис" для получения списка АЗС и их конфигураций **через HTTP **запрос на **baseUrl **с префиксом **/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
36 +Внешняя система опрашивает "Топаз-Web Office" для получения списка АЗС и их конфигураций **через HTTP **запрос на **baseUrl **с префиксом **/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
31 31  
32 32  В ответ Топаз "Web Офис" дает ответ в формате **JSON**
33 33  
... ... @@ -79,7 +79,7 @@
79 79  
80 80  == Получение прайс-листа ==
81 81  
82 -Внешняя система опрашивает Топаз "Web Офис" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
88 +Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
83 83  
84 84  В ответ Топаз "Web Офис" дает ответ в формате **JSON**{{{}}}
85 85  
... ... @@ -113,7 +113,7 @@
113 113  
114 114  [[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2]]
115 115  
116 -Информирование Топаз "Web Офис" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
122 +Информирование "Топаз-Web Office" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
117 117  
118 118  
119 119  **Тело запроса содержит JSON вида Order**{{{}}}
... ... @@ -185,11 +185,11 @@
185 185  
186 186  === Статус Accept ===
187 187  
188 -Данный статус сообщает внешней системе о том, что заказ принят и обработан в Топаз "Web Офис"
194 +Данный статус сообщает внешней системе о том, что заказ принят и обработан в "Топаз-Web Office"
189 189  
190 -Данный статус Топаз "Web Офис"отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
196 +Данный статус "Топаз-Web Office" отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
191 191  
192 -В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
198 +В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
193 193  
194 194  **baseUrl + /api/order/accept POST**
195 195  
... ... @@ -199,11 +199,11 @@
199 199  
200 200  === Статус Fueling ===
201 201  
202 -Данный статус сообщает внешней системе о том, что Топаз "Web Офис" готов запустить колонку (начать пролив)
208 +Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
203 203  
204 -Данный статус Топаз "Web Офис" отсылает перед началом пуска колонки
210 +Данный статус "Топаз-Web Office" отсылает перед началом пуска колонки
205 205  
206 -В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
212 +В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
207 207  
208 208  **baseUrl + /api/order/fueling POST**
209 209  
... ... @@ -229,7 +229,7 @@
229 229  
230 230  Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
231 231  
232 -В случае если внешняя система дала ответ отличный от **200 ОК **, то Топаз "Web Офис" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
238 +В случае если внешняя система дала ответ отличный от **200 ОК **, то "Топаз-Web Office" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
233 233  
234 234  **baseUrl + /api/order/completed POST**
235 235  
... ... @@ -245,9 +245,9 @@
245 245  
246 246  === Отправка счетчика налива ===
247 247  
248 -В момент процесса налива Топаз "Web Офис" может сообщать внешней системе статус счетчика налива
254 +В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива
249 249  
250 -Для этого с периодичностью от 5 – 10 секунд Топаз "Web Офис" выполняет следующий запрос
256 +Для этого с периодичностью от 5 – 10 секунд "Топаз-Web Office" выполняет следующий запрос
251 251  
252 252  **baseUrl + /api/order/volume**
253 253