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

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

От 20.3 до 20.2 От 38.1 до 37.5

От версии 37.5

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

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

К версии 20.3

отредактировано Dmitriy
на 2024/12/03 12:21

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

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

Сводка

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

Подробности

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

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

@@ -1,1 +1,1 @@
--vneshnie_api.vneshnie_nalivy2.WebHome
++Main.WebHome

Содержимое

@@ -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 секунд.
@@ -51,28 +51,28 @@
  **...**
--{{code language="javascript" layout="LINENUMBERS"}}
++{{code language="javascript"}}
  {
  // идентификатор станции АЗС
--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
  }
@@ -80,8 +80,7 @@
  **Возможные идентификаторы топлива**
--(% border="1" %)
--|(% style="background-color:#e5e4e2; border-color:black" %)ID|(% style="background-color:#e5e4e2; border-color:black" %)Марка
++|ID|Марка
  |diesel|дизель
  |diesel_premium|брендированный дизель
  |a80|бензин марки А80
@@ -96,8 +96,6 @@
  |propane|газ пропан
  |metan|метан
--==  ==
--
  == Получение прайс-листа ==
  Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
@@ -104,101 +104,80 @@
  В ответ Топаз "Web Офис" дает ответ в формате **JSON**{{{}}}
--{{code language="javascript" layout="LINENUMBERS"}}
++{{code language="javascript"}}
  {
   {
   // идентификатор станции внутри Топаз "Web Офис"
-- string stationId,
++ string StationId,
   // идентификатор топлива
-- string productId,
++ string ProductId,
   // цена за 1 литр
-- double price
-- // Внешний код топлива
-- string fuelExtendedId
++ double Price
   },
  …. N
  }
  {{/code}}
++
++
  **Пример ответа**{{{}}}
  {{code language="javascript"}}
  {
--{"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"},
++{"StationId": "0001", "ProductId": "a92", "Price": 38.66},
++{"StationId": "0001", "ProductId": "a95_premium", "Price": 45.21},
++{"StationId": "0002", "ProductId": "a92", "Price": 38.98},
  }
  {{/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"}}
++**Тело запроса содержит JSON вида Order**{{{}}}
++
++{{code language="javascript"}}
  {
--// Идентификатор заказа
--String Id
++// идентификатор заказа
++string Id
  // дата и время создания в UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
--String DateCreate
++String DateCreate
++// значение заказа
++double OrderVolume
  // идентификатор станции АЗС
--String StationExtendedId
--// Тип заказа
--String OrderType
--// номер стороны (поста)
++string StationExtendedId
++// номер колонки
  int ColumnId
--// Идентификатор топлива
--String FuelId
--// Стоимость 1 литра топлива
++// идентификатор топлива
++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
--// Итого заправлено
++// идентификатор причины отмены заказа
++string ReasonId
++// причина отмены
++string Reason
++// итого сумма литров залито
  double LitreCompleted
--// Итого оплачено по завершению заказа
++// итого оплачено по завершению заказа
  double SumPaidCompleted
--// Идентификатор договора
--String ContractId
--// Способ оплаты
--String PayType
++// идентификатор договора
++string ContractId
  }
  {{/code}}
--**Обязательными полями при создании нового заказа являются:**
--
--{{code layout="LINENUMBERS" language="javascript"}}
--{
--  "Id": "string",
--  "DateCreate": "string",
--  "OrderType": "Money",
--  "StationExtendedId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "ColumnId": 0,
--  "FuelId": "diesel"
--  "PriceFuel": 0,
--  "Sum": 0,
--  "Litre": 0,
--  "Status": "OrderCreated"
--  "ContractId": "string"
--}
--{{/code}}
--
  Параметр **OrderType **– тип заказа может принимать следующие значения:
  * **Money **– заправка на фиксированную сумму
@@ -222,47 +222,12 @@
  При получении заказа в статусе **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" отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
@@ -269,18 +269,14 @@
  В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
--**baseUrl + /api/order/accept**
++**baseUrl + /api/order/accept POST**
--**POST**
--
  **apikey={apikey}&orderId={ordeId}**
  все параметры являются обязательными
--===  ===
++=== Статус Fueling ===
--=== **Статус Fueling** ===
--
  Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
  Данный статус "Топаз-Web Office" отсылает перед началом пуска колонки
@@ -287,18 +287,14 @@
  В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
--**baseUrl + /api/order/fueling**
++**baseUrl + /api/order/fueling POST**
--**POST**
--
  **apikey={apikey}&orderId={ordeId}**
  все параметры являются обязательными
--===  ===
++=== Статус Canceled ===
--=== **Статус Canceled** ===
--
  Данный статус сообщает внешней системе о том, что заказ следует отменить
  **baseUrl + /api/order/canceled**
@@ -311,10 +311,8 @@
  **reason – **текстовая причина отмены
--===  ===
++=== Статус Completed ===
--=== **Статус Completed** ===
--
  Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
  В случае если внешняя система дала ответ отличный от **200 ОК **, то "Топаз-Web Office" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
@@ -321,8 +321,10 @@
  **baseUrl + /api/order/completed POST**
--**apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&extendedDate={extendedDate}**
++**apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&**
++**extendedDate={extendedDate}**
++
  все параметры являются обязательными
  **litre **– кол-во пролитых литров, указывается как **double **с разделителем точка **extendedOrderId **– идентификатор заказа в АСУ сети
@@ -329,10 +329,8 @@
  **extendedDate **– дата по которой АСУ строит отчет для сверки, формат **dd.MM.yyyy HH:mm:ss**
--===  ===
++=== Отправка счетчика налива ===
--=== **Отправка счетчика налива** ===
--
  В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива
  Для этого с периодичностью от 5 – 10 секунд "Топаз-Web Office" выполняет следующий запрос
@@ -346,3 +346,21 @@
  все параметры являются обязательными
  **litre **– кол-во пролитых на момент отправки запроса литров, указывается как double с разделителем точка
++
++== Проверка статуса работы станции ==
++
++Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
++
++**/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
++
++**columnId **– идентификатор ТРК
++
++запрос типа **GET **, timeout 10 секунд.
++
++== Статусы ответов ==
++
++**200 ОК **– станция и ТРК готова принять и обработать заказ
++
++**400 **– станция или ТРК не найдена (не верный идентификатор станции или ТРК) **404 **– ТРК занята / ТРК не готова принять заказ
++
++любой ответ не **200 ОК **– интерпретируется как на станции нет интернета / станция не доступна