Изменения документа Протокол интеграции систем внешних наливов с Топаз "Web Офис"

Редактировал(а) Dmitriy 2026/04/23 06:18

От 23.1 до 22.1 От 35.1 до 34.1

От версии 34.1

отредактировано Ярослава Ерина
на 2024/12/11 13:29

Изменить комментарий: К данной версии нет комментариев

К версии 23.1

отредактировано Dmitriy
на 2024/12/06 10:17

Изменить комментарий: К данной версии нет комментариев

Необработанный
Обработанный

Сводка

Свойства страницы (2 изменено, 0 добавлено, 0 удалено)

Подробности

Свойства страницы

Автор документа

@@ -1,1 +1,1 @@
--XWiki.erina_jv
++XWiki.erin_ds

Содержимое

@@ -1,4 +1,4 @@
--v 1.0.1
++====== **v 1.0.1** ======
  == Настройка перед интеграцией ==
@@ -18,11 +18,8 @@
  (% class="box errormessage" %)
  (((
--(% class="wikigeneratedid" id="H41443043D43D44B43943A43B44E44743D43543E43144543E43443843C43E43144343443544243F43544043543443043243044244C43243E43244143544543743043F44043E44143044543E44243243D43544843D43543944143844144243543C44B4322242243E43F430437-WebOffice2243243743043343E43B43E43243A43528header29externalSystemApikey" %)
--(((
  === **Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey** ===
  )))
--)))
  == ApiKey ==
@@ -34,15 +34,6 @@
  Базовым адресом **(baseUrl)** для выполнения запросов является  [[https:~~/~~/topazoffice.ru/ms/external-fueling/integration>>https://topazoffice.ru/ms/external-fueling/integration]]
------
--
--== **Методы API "Топаз-Web Office":** ==
--
--1. **Получение списка АЗС и их конфигураций**
--1. **Получение прайс-листа**
--1. **Получение и обработка заказа**
--1. **Проверка статуса работы станции**
--
  == Получение списка АЗС и их конфигураций ==
  Внешняя система опрашивает "Топаз-Web Office" для получения списка АЗС и их конфигураций **через HTTP **запрос на **baseUrl **с префиксом **/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
@@ -95,8 +95,6 @@
  |propane|газ пропан
  |metan|метан
--==  ==
--
  == Получение прайс-листа ==
  Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
@@ -117,6 +117,8 @@
  }
  {{/code}}
++
++
  **Пример ответа**{{{}}}
  {{code language="javascript"}}
@@ -127,14 +127,13 @@
  }
  {{/code}}
--==  ==
++== Обработка заказа ==
--== Получение и обработка заказа ==
++[[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2]]
--[[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2||data-xwiki-image-style-border="true"]]
--
  Информирование "Топаз-Web Office" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
++
  **Тело запроса содержит JSON вида Order{{{}}}**
  {{code language="javascript" layout="LINENUMBERS"}}
@@ -219,45 +219,14 @@
  При получении заказа в статусе **OrderCreated **Топаз "Web Офис" проверяет ряд параметров **StationExtendedId **– в случае если идентификатор станции не найден в Топаз "Web Офис", то Топаз "Web Офис" дает ответ **400**
--**FuelId **+ **PriceFuel **– в случае если стоимость топлива в Топаз "Web Офис" отличается от присланной, то Топаз "Web Офис" дает ответ **402.**
++**FuelId **+ **PriceFuel **– в случае если стоимость топлива в Топаз "Web Офис" отличается от присланной, то Топаз "Web Офис" дает ответ **402**
++== Передача статусов о заказе ==
--== Проверка статуса работы станции ==
++Для получения статусов Интегратору необходимо со своей стороны реализовать сервис для их получения и обработки
--Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
++=== Статус Accepted ===
--**/ping?apikey={apikey}&stationId={stationId}&columnId={columnId},**
--
--**stationId **– идентификатор станции
--
--**columnId **– идентификатор стороны ТРК
--
--запрос типа **GET **, timeout 10 секунд.
--
--==== **Статусы ответов** ====
--
--**200 ОК **– станция и ТРК готова принять и обработать заказ
--
--**400 **– станция или ТРК не найдена (не верный идентификатор станции или ТРК) **404 **– ТРК занята / ТРК не готова принять заказ
--
--любой ответ не **200 ОК **– интерпретируется как на станции нет интернета / станция не доступна
--
------
--
--Для получения статусов Интегратору необходимо со своей стороны реализовать сервис для их получения и обработки.
--
--== **Методы REST API интегратора (внешней системы):** ==
--
--1. **Статус Accepted**
--1. **Статус Fueling**
--1. **Статус Canceled**
--1. **Статус Completed**
--1. **Отправка счетчика налива**
--
--Данные запросы "Топаз-Web Office" отправляет Интегратору.
--
--=== **Статус Accepted** ===
--
  Данный статус сообщает внешней системе о том, что заказ принят и обработан в "Топаз-Web Office"
  Данный статус "Топаз-Web Office" отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
@@ -272,10 +272,8 @@
  все параметры являются обязательными
--===  ===
++=== Статус Fueling ===
--=== **Статус Fueling** ===
--
  Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
  Данный статус "Топаз-Web Office" отсылает перед началом пуска колонки
@@ -290,10 +290,8 @@
  все параметры являются обязательными
--===  ===
++=== Статус Canceled ===
--=== **Статус Canceled** ===
--
  Данный статус сообщает внешней системе о том, что заказ следует отменить
  **baseUrl + /api/order/canceled**
@@ -306,10 +306,8 @@
  **reason – **текстовая причина отмены
--===  ===
++=== Статус Completed ===
--=== **Статус Completed** ===
--
  Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
  В случае если внешняя система дала ответ отличный от **200 ОК **, то "Топаз-Web Office" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
@@ -324,10 +324,8 @@
  **extendedDate **– дата по которой АСУ строит отчет для сверки, формат **dd.MM.yyyy HH:mm:ss**
--===  ===
++=== Отправка счетчика налива ===
--=== **Отправка счетчика налива** ===
--
  В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива
  Для этого с периодичностью от 5 – 10 секунд "Топаз-Web Office" выполняет следующий запрос
@@ -341,3 +341,23 @@
  все параметры являются обязательными
  **litre **– кол-во пролитых на момент отправки запроса литров, указывается как double с разделителем точка
++
++== Проверка статуса работы станции ==
++
++Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
++
++**/ping?apikey={apikey}&stationId={stationId}&columnId={columnId},**
++
++**stationId **– идентификатор станции
++
++**columnId **– идентификатор стороны ТРК
++
++запрос типа **GET **, timeout 10 секунд.
++
++== Статусы ответов ==
++
++**200 ОК **– станция и ТРК готова принять и обработать заказ
++
++**400 **– станция или ТРК не найдена (не верный идентификатор станции или ТРК) **404 **– ТРК занята / ТРК не готова принять заказ
++
++любой ответ не **200 ОК **– интерпретируется как на станции нет интернета / станция не доступна