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

Сводка

Подробности

Свойства страницы
Содержимое
... ... @@ -3,7 +3,7 @@
3 3  == Настройка перед интеграцией ==
4 4  
5 5  
6 -Перед началом интеграции, уполномоченный сотрудник компании, предоставляющей услуги внешних наливов (далее Интегратор), передает в ООО "Топаз-сервис" следующую информацию:
6 +Перед началом интеграции, уполномоченный сотрудник компании, предоставляющей услуги внешних наливов, передает в ООО "Топаз-сервис" следующую информацию:
7 7  
8 8  1. Базовый url тестового окружения системы внешнего налива
9 9  1. Список ip адресов, с которых будут приходить запросы от тестового окружения системы внешнего налива
... ... @@ -14,19 +14,8 @@
14 14  
15 15  После получения информации по указанным пунктам, от ООО "Топаз-сервис" будет предоставлен тестовый доступ для настройки интеграции.
16 16  
17 -Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в "Топаз-Web Office".
17 +Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в Топаз "Web Офис". Данный ключ необходимо будет передавать во всех запросах от внешней системы в Топаз "Web Офис" в заголовке externalSystemApikey
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 30  == Адрес для отправки запросов ==
31 31  
32 32  Базовым адресом **(baseUrl)** для выполнения запросов является [[https:~~/~~/topazoffice.ru/ms/external-fueling/integration>>https://topazoffice.ru/ms/external-fueling/integration]]
... ... @@ -33,7 +33,7 @@
33 33  
34 34  == Получение списка АЗС и их конфигураций ==
35 35  
36 -Внешняя система опрашивает "Топаз-Web Office" для получения списка АЗС и их конфигураций **через HTTP **запрос на **baseUrl **с префиксом **/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
25 +Внешняя система опрашивает Топаз "Web Офис" для получения списка АЗС и их конфигураций **через HTTP **запрос на **baseUrl **с префиксом **/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
37 37  
38 38  В ответ Топаз "Web Офис" дает ответ в формате **JSON**
39 39  
... ... @@ -85,7 +85,7 @@
85 85  
86 86  == Получение прайс-листа ==
87 87  
88 -Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
77 +Внешняя система опрашивает Топаз "Web Офис" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
89 89  
90 90  В ответ Топаз "Web Офис" дает ответ в формате **JSON**{{{}}}
91 91  
... ... @@ -119,7 +119,7 @@
119 119  
120 120  [[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2]]
121 121  
122 -Информирование "Топаз-Web Office" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
111 +Информирование Топаз "Web Офис" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
123 123  
124 124  
125 125  **Тело запроса содержит JSON вида Order**{{{}}}
... ... @@ -191,11 +191,11 @@
191 191  
192 192  === Статус Accept ===
193 193  
194 -Данный статус сообщает внешней системе о том, что заказ принят и обработан в "Топаз-Web Office"
183 +Данный статус сообщает внешней системе о том, что заказ принят и обработан в Топаз "Web Офис"
195 195  
196 -Данный статус "Топаз-Web Office" отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
185 +Данный статус Топаз "Web Офис"отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
197 197  
198 -В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
187 +В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
199 199  
200 200  **baseUrl + /api/order/accept POST**
201 201  
... ... @@ -205,11 +205,11 @@
205 205  
206 206  === Статус Fueling ===
207 207  
208 -Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
197 +Данный статус сообщает внешней системе о том, что Топаз "Web Офис" готов запустить колонку (начать пролив)
209 209  
210 -Данный статус "Топаз-Web Office" отсылает перед началом пуска колонки
199 +Данный статус Топаз "Web Офис" отсылает перед началом пуска колонки
211 211  
212 -В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
201 +В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
213 213  
214 214  **baseUrl + /api/order/fueling POST**
215 215  
... ... @@ -235,7 +235,7 @@
235 235  
236 236  Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
237 237  
238 -В случае если внешняя система дала ответ отличный от **200 ОК **, то "Топаз-Web Office" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
227 +В случае если внешняя система дала ответ отличный от **200 ОК **, то Топаз "Web Офис" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
239 239  
240 240  **baseUrl + /api/order/completed POST**
241 241  
... ... @@ -251,9 +251,9 @@
251 251  
252 252  === Отправка счетчика налива ===
253 253  
254 -В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива
243 +В момент процесса налива Топаз "Web Офис" может сообщать внешней системе статус счетчика налива
255 255  
256 -Для этого с периодичностью от 5 – 10 секунд "Топаз-Web Office" выполняет следующий запрос
245 +Для этого с периодичностью от 5 – 10 секунд Топаз "Web Офис" выполняет следующий запрос
257 257  
258 258  **baseUrl + /api/order/volume**
259 259