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

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

От 22.1 до 23.1 От 37.3 до 37.4

От версии 23.1

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

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

К версии 37.3

отредактировано Dmitriy
на 2025/02/19 08:59

Изменить комментарий: Update document after refactoring.

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

Сводка

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

Подробности

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

Родительский документ

@@ -1,1 +1,1 @@
--Main.WebHome
++vneshnie_api.Внешние наливы.WebHome

Содержимое

@@ -1,4 +1,4 @@
--====== **v 1.0.1** ======
++v 1.0.1
  == Настройка перед интеграцией ==
@@ -18,8 +18,11 @@
  (% class="box errormessage" %)
  (((
++(% class="wikigeneratedid" id="H41443043D43D44B43943A43B44E44743D43543E43144543E43443843C43E43144343443544243F43544043543443043243044244C43243E43244143544543743043F44043E44143044543E44243243D43544843D43543944143844144243543C44B4322242243E43F430437-WebOffice2243243743043343E43B43E43243A43528header29externalSystemApikey" %)
++(((
  === **Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey** ===
  )))
++)))
  == ApiKey ==
@@ -31,6 +31,15 @@
  Базовым адресом **(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 секунд.
@@ -42,25 +42,25 @@
  {{code language="javascript" layout="LINENUMBERS"}}
  {
  // идентификатор станции АЗС
--string Id
++string id
  // статус станции: true – доступна, false – выключена
--bool Enable,
++bool enable,
  // наименование станции
--string Name,
++string name,
  // адрес станции
--string Address,
++string address,
  // гео точка на карте
--location Location
++location location
  {
--double Lat,
--double Lon },
++double lat,
++double lon },
  // словарь доступных ТРК
--Dictionary Columns {
++Dictionary columns {
  // номер колонки
  (int32) Key:
  {
  // список доступных типов топлива
--"Fuels": [ "a92", "a95", "diesel_premium", ... N ]
++"fuels": [ "a92", "a95", "diesel_premium", ... N ]
  }
  } ... N
  }
@@ -68,7 +68,8 @@
  **Возможные идентификаторы топлива**
--|ID|Марка
++(% border="1" %)
++|(% style="background-color:#e5e4e2; border-color:black" %)ID|(% style="background-color:#e5e4e2; border-color:black" %)Марка
  |diesel|дизель
  |diesel_premium|брендированный дизель
  |a80|бензин марки А80
@@ -83,6 +83,8 @@
  |propane|газ пропан
  |metan|метан
++==  ==
++
  == Получение прайс-листа ==
  Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
@@ -93,35 +93,36 @@
  {
   {
   // идентификатор станции внутри Топаз "Web Офис"
-- string StationId,
++ string stationId,
   // идентификатор топлива
-- string ProductId,
++ string productId,
   // цена за 1 литр
-- double Price
++ double price
++ // Внешний код топлива
++ string fuelExtendedId
   },
  …. N
  }
  {{/code}}
--
--
  **Пример ответа**{{{}}}
  {{code language="javascript"}}
  {
--{"StationId": "0001", "ProductId": "a92", "Price": 38.66},
--{"StationId": "0001", "ProductId": "a95_premium", "Price": 45.21},
--{"StationId": "0002", "ProductId": "a92", "Price": 38.98},
++{"stationId": "0001", "productId": "a92", "price": 38.66, "fuelExtendedId": "92"},
++{"stationId": "0001", "productId": "a95_premium", "price": 45.21, "fuelExtendedId": "95"},
++{"stationId": "0002", "productId": "a92", "price": 38.98, , "fuelExtendedId": "92"},
  }
  {{/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"}}
@@ -206,14 +206,47 @@
  При получении заказа в статусе **OrderCreated **Топаз "Web Офис" проверяет ряд параметров **StationExtendedId **– в случае если идентификатор станции не найден в Топаз "Web Офис", то Топаз "Web Офис" дает ответ **400**
--**FuelId **+ **PriceFuel **– в случае если стоимость топлива в Топаз "Web Офис" отличается от присланной, то Топаз "Web Офис" дает ответ **402**
++**FuelId **+ **PriceFuel **– в случае если стоимость топлива в Топаз "Web Офис" отличается от присланной, то Топаз "Web Офис" дает ответ **402.**
--== Передача статусов о заказе ==
--Для получения статусов Интегратору необходимо со своей стороны реализовать сервис для их получения и обработки
++== Проверка статуса работы станции ==
--=== Статус Accepted ===
++Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
++**/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" отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
@@ -228,8 +228,10 @@
  все параметры являются обязательными
--=== Статус Fueling ===
++===  ===
++=== **Статус Fueling** ===
++
  Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
  Данный статус "Топаз-Web Office" отсылает перед началом пуска колонки
@@ -244,8 +244,10 @@
  все параметры являются обязательными
--=== Статус Canceled ===
++===  ===
++=== **Статус Canceled** ===
++
  Данный статус сообщает внешней системе о том, что заказ следует отменить
  **baseUrl + /api/order/canceled**
@@ -258,8 +258,10 @@
  **reason – **текстовая причина отмены
--=== Статус Completed ===
++===  ===
++=== **Статус Completed** ===
++
  Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
  В случае если внешняя система дала ответ отличный от **200 ОК **, то "Топаз-Web Office" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
@@ -274,8 +274,10 @@
  **extendedDate **– дата по которой АСУ строит отчет для сверки, формат **dd.MM.yyyy HH:mm:ss**
--=== Отправка счетчика налива ===
++===  ===
++=== **Отправка счетчика налива** ===
++
  В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива
  Для этого с периодичностью от 5 – 10 секунд "Топаз-Web Office" выполняет следующий запрос
@@ -289,23 +289,3 @@
  все параметры являются обязательными
  **litre **– кол-во пролитых на момент отправки запроса литров, указывается как double с разделителем точка
--
--== Проверка статуса работы станции ==
--
--Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
--
--**/ping?apikey={apikey}&stationId={stationId}&columnId={columnId},**
--
--**stationId **– идентификатор станции
--
--**columnId **– идентификатор стороны ТРК
--
--запрос типа **GET **, timeout 10 секунд.
--
--== Статусы ответов ==
--
--**200 ОК **– станция и ТРК готова принять и обработать заказ
--
--**400 **– станция или ТРК не найдена (не верный идентификатор станции или ТРК) **404 **– ТРК занята / ТРК не готова принять заказ
--
--любой ответ не **200 ОК **– интерпретируется как на станции нет интернета / станция не доступна