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

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

От 6.1 до 5.1 От 32.1 до 31.1

От версии 31.1

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

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

К версии 6.1

отредактировано Ярослава Ерина
на 2024/07/30 05:23

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

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

Сводка

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

Подробности

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

Содержимое

@@ -1,11 +1,9 @@
--{{toc/}}
++====== **v 1.0.1** ======
--v 1.0.1
--
  == Настройка перед интеграцией ==
--Перед началом интеграции, уполномоченный сотрудник компании, предоставляющей услуги внешних наливов (далее Интегратор), передает в ООО "Топаз-сервис" следующую информацию:
++Перед началом интеграции, уполномоченный сотрудник компании, предоставляющей услуги внешних наливов, передает в ООО "Топаз-сервис" следующую информацию:
 . Базовый url тестового окружения системы внешнего налива
 . Список ip адресов, с которых будут приходить запросы от тестового окружения системы внешнего налива
@@ -16,69 +16,33 @@
  После получения информации по указанным пунктам, от ООО "Топаз-сервис" будет предоставлен тестовый доступ для настройки интеграции.
--Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в "Топаз-Web Office".
++Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в Топаз "Web Офис". Данный ключ необходимо будет передавать во всех запросах от внешней системы в Топаз "Web Офис" в заголовке externalSystemApikey
--(% class="box errormessage" %)
--(((
--(% class="wikigeneratedid" id="H41443043D43D44B43943A43B44E44743D43543E43144543E43443843C43E43144343443544243F43544043543443043243044244C43243E43244143544543743043F44043E44143044543E44243243D43544843D43543944143844144243543C44B4322242243E43F430437-WebOffice2243243743043343E43B43E43243A43528header29externalSystemApikey" %)
--(((
--**Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey**
--)))
--)))
--
--== ApiKey ==
--
--(% class="wikigeneratedid" %)
--Интегратору необходимо для каждого своего клиента (сети АЗС) сформировать и хранить в собственной базе данных уникальный Apikey.
--С помощью этого Apikey происходит идентификация клиента (сети АЗС) при обмене между "Топаз-Web Office" и системой Интегратора.
--
--== Адрес для отправки запросов ==
--
--Базовым адресом **(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 секунд.
++Внешняя система опрашивает Топаз "Web Офис" для получения списка АЗС и их конфигураций **через HTTP **запрос на **url **с префиксом **/integration/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
  В ответ Топаз "Web Офис" дает ответ в формате **JSON**
  **...**
--{{code language="javascript" layout="LINENUMBERS"}}
--{
--// идентификатор станции АЗС
--string Id
--// статус станции: true – доступна, false – выключена
--bool Enable,
--// наименование станции
--string Name,
--// адрес станции
--string Address,
--// гео точка на карте
--location Location
++**{{code language="javascript" layout="LINENUMBERS"}}{
++// идентификатор станции АЗС string Id
++// статус станции: true – доступна, false – выключена bool Enable,
++// наименование станции string Name,
++// адрес станции string Address,
++// гео точка на карте location Location
++{ double Lat, double Lon }, // словарь доступных ТРК Dictionary Columns {
++// номер колонки (int32) Key:
  {
--double Lat,
--double Lon },
--// словарь доступных ТРК
--Dictionary Columns {
--// номер колонки
--(int32) Key:
--{
  // список доступных типов топлива
  "Fuels": [ "a92", "a95", "diesel_premium", ... N ]
  }
  } ... N
--}
--{{/code}}
++}{{/code}}**
++{{{{ // идентификатор станции АЗС string Id // статус станции: true – доступна, false – выключена bool Enable, // наименование станции string Name, // адрес станции string Address, // гео точка на карте location Location { double Lat, double Lon }, // словарь доступных ТРК Dictionary Columns { // номер колонки (int32) Key: { // список доступных типов топлива "Fuels": [ "a92", "a95", "diesel_premium", ... N ] } } ... N }}}}
++
  **Возможные идентификаторы топлива**
  |ID|Марка
@@ -98,113 +98,36 @@
  == Получение прайс-листа ==
--Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
++Внешняя система опрашивает Топаз "Web Офис" для получения прайс-листа **HTTP **запросом на **url **с префиксом **/integration/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
--В ответ Топаз "Web Офис" дает ответ в формате **JSON**{{{}}}
++В ответ Топаз "Web Офис" дает ответ в формате **JSON**
--{{code language="javascript" layout="LINENUMBERS"}}
--{
-- {
-- // идентификатор станции внутри Топаз "Web Офис"
-- string StationId,
-- // идентификатор топлива
-- string ProductId,
-- // цена за 1 литр
-- double Price
-- },
--…. N
--}
--{{/code}}
++{{{{ { // идентификатор станции внутри Топаз "Web Офис" string StationId, // идентификатор топлива string ProductId, // цена за 1 литр double Price }, …. N }}}}
++**Пример ответа**
--**Пример ответа**{{{}}}
++{{{{ {“StationId”: “0001”, “ProductId”: “a92”, “Price”: 38.66}, {“StationId”: “0001”, “ProductId”: “a95_premium”, “Price”: 45.21}, {“StationId”: “0002”, “ProductId”: “a92”, “Price”: 38.98}, }}}}
--{{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},
--}
--{{/code}}
++== Обработка заказа ==
--== Получение и обработка заказа ==
--
  [[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2]]
--Информирование "Топаз-Web Office" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
++Информирование Топаз "Web Офис" о заказе и их статусах осуществляется **HTTP **запросом на **url **с префиксом **/integration/order **, запрос типа **POST **, timeout 10 секунд.
--**Тело запроса содержит JSON вида Order{{{}}}**
++**Тело запроса содержит JSON вида Order**
--{{code language="javascript" layout="LINENUMBERS"}}
--{
--// Идентификатор заказа
--String Id
--// дата и время создания в UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
--String DateCreate
--// идентификатор станции АЗС
--String StationExtendedId
--// Тип заказа
--String OrderType
--// номер стороны (поста)
--int ColumnId
--// Идентификатор топлива
--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
--// Итого заправлено
--double LitreCompleted
--// Итого оплачено по завершению заказа
--double SumPaidCompleted
--// Идентификатор договора
--String ContractId
--// Способ оплаты
--String PayType
--}
--{{/code}}
++{{{{ // идентификатор заказа string Id // дата и время создания в UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss String DateCreate // значение заказа double OrderVolume // идентификатор станции АЗС string StationExtendedId // номер колонки int ColumnId // идентификатор топлива 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 // итого сумма литров залито double LitreCompleted // итого оплачено по завершению заказа double SumPaidCompleted // идентификатор договора string ContractId }}}}
--**Обязательными полями при создании нового заказа являются:**
--
--{{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 **– заправка на фиксированную сумму
--* **Liters **– заправка на литры
++* **Money **– заправка на фиксированную сумму, **OrderVolume **– сумма рублей
++* **Liters **– заправка на литры, **OrderVolume **– кол-вол литров
  Параметр **Status **– статус заказа может принимать следующие значения
  * **OrderCreated **– заказ создан и полностью оплачен
--* **Accepted **- АЗС готова начать налив
--* **Expired **– статус от АЗС не поступил в течение 30 минут
++* **Expire **– статус от АЗС не поступил в течение 30 минут
  * **Completed **– заказа завершен успешно
  * **StationCanceled **– заказ отменен оператором АЗС или же Топаз "Web Офис"
  * **UserCanceled **– заказ отменен пользователем
@@ -218,80 +218,43 @@
  При получении заказа в статусе **OrderCreated **Топаз "Web Офис" проверяет ряд параметров **StationExtendedId **– в случае если идентификатор станции не найден в Топаз "Web Офис", то Топаз "Web Офис" дает ответ **400**
--**FuelId **+ **PriceFuel **– в случае если стоимость топлива в Топаз "Web Офис" отличается от присланной, то Топаз "Web Офис" дает ответ **402.**
++**FuelId **+ **PriceFuel **– в случае если стоимость топлива в Топаз "Web Офис" отличается от присланной, то Топаз "Web Офис" дает ответ **402**
++== Передача статусов о заказе ==
--== Проверка статуса работы станции ==
++=== Статус Accept ===
--Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
++Данный статус сообщает внешней системе о том, что заказ принят и обработан в Топаз "Web Офис"
--**/ping?apikey={apikey}&stationId={stationId}&columnId={columnId},**
++Данный статус Топаз "Web Офис"отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
--**stationId **– идентификатор станции
++В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
--**columnId **– идентификатор стороны ТРК
++**базовый url + /api/order/accept POST**
--запрос типа **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" отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
--
--В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
--
--**baseUrl + /api/order/accept**
--
--**POST**
--
  **apikey={apikey}&orderId={ordeId}**
  все параметры являются обязательными
--=== **Статус Fueling** ===
++=== Статус Fueling ===
--Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
++Данный статус сообщает внешней системе о том, что Топаз "Web Офис" готов запустить колонку (начать пролив)
--Данный статус "Топаз-Web Office" отсылает перед началом пуска колонки
++Данный статус Топаз "Web Офис" отсылает перед началом пуска колонки
--В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
++В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
--**baseUrl + /api/order/fueling**
++**базовый url + /api/order/fueling POST**
--**POST**
--
  **apikey={apikey}&orderId={ordeId}**
  все параметры являются обязательными
--=== **Статус Canceled** ===
++=== Статус Canceled ===
  Данный статус сообщает внешней системе о том, что заказ следует отменить
--**baseUrl + /api/order/canceled**
++**базовый url + /api/order/canceled**
  **POST**
@@ -301,16 +301,18 @@
  **reason – **текстовая причина отмены
--=== **Статус Completed** ===
++=== Статус Completed ===
  Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
--В случае если внешняя система дала ответ отличный от **200 ОК **, то "Топаз-Web Office" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
++В случае если внешняя система дала ответ отличный от **200 ОК **, то Топаз "Web Офис" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
--**baseUrl + /api/order/completed POST**
++**базовый url + /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 **– идентификатор заказа в АСУ сети
@@ -317,13 +317,13 @@
  **extendedDate **– дата по которой АСУ строит отчет для сверки, формат **dd.MM.yyyy HH:mm:ss**
--=== **Отправка счетчика налива** ===
++=== Отправка счетчика налива ===
--В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива
++В момент процесса налива Топаз "Web Офис" может сообщать внешней системе статус счетчика налива
--Для этого с периодичностью от 5 – 10 секунд "Топаз-Web Office" выполняет следующий запрос
++Для этого с периодичностью от 5 – 10 секунд Топаз "Web Офис" выполняет следующий запрос
--**baseUrl + /api/order/volume**
++**базовый url + /api/order/volume**
  **POST**
@@ -332,3 +332,21 @@
  все параметры являются обязательными
  **litre **– кол-во пролитых на момент отправки запроса литров, указывается как double с разделителем точка
++
++== Проверка статуса работы станции ==
++
++Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ url с префиксом
++
++**/integration/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
++
++**columnId **– идентификатор ТРК
++
++запрос типа **GET **, timeout 10 секунд.
++
++== Статусы ответов ==
++
++**200 ОК **– станция и ТРК готова принять и обработать заказ
++
++**400 **– станция или ТРК не найдена (не верный идентификатор станции или ТРК) **404 **– ТРК занята / ТРК не готова принять заказ
++
++любой ответ не **200 ОК **– интерпретируется как на станции нет интернета / станция не доступна