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

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

От 23.1 до 24.1

От версии 1.1

отредактировано Ярослава Ерина
на 2024/07/17 12:36

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

К версии 23.1

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

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

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

Сводка

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

Подробности

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

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

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

Содержимое

@@ -3,7 +3,7 @@
  == Настройка перед интеграцией ==
--Перед началом интеграции, уполномоченный сотрудник компании, предоставляющей услуги внешних наливов, передает в ООО "Топаз-сервис" следующую информацию:
++Перед началом интеграции, уполномоченный сотрудник компании, предоставляющей услуги внешних наливов (далее Интегратор), передает в ООО "Топаз-сервис" следующую информацию:
 . Базовый url тестового окружения системы внешнего налива
 . Список ip адресов, с которых будут приходить запросы от тестового окружения системы внешнего налива
@@ -14,48 +14,57 @@
  После получения информации по указанным пунктам, от ООО "Топаз-сервис" будет предоставлен тестовый доступ для настройки интеграции.
--Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в Топаз "Web Офис". Данный ключ необходимо будет передавать во всех запросах от внешней системы в Топаз "Web Офис" в заголовке externalSystemApikey
++Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в "Топаз-Web Office".
++(% class="box errormessage" %)
++(((
++=== **Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-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]]
++
  == Получение списка АЗС и их конфигураций ==
--Внешняя система опрашивает Топаз "Web Офис" для получения списка АЗС и их конфигураций **через HTTP **запрос на **url **с префиксом **/integration/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
++Внешняя система опрашивает "Топаз-Web Office" для получения списка АЗС и их конфигураций **через HTTP **запрос на **baseUrl **с префиксом **/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
  В ответ Топаз "Web Офис" дает ответ в формате **JSON**
  **...**
--{{{{
-- // идентификатор станции АЗС
-- 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
--}}}}
++{{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:
++{
++// список доступных типов топлива
++"Fuels": [ "a92", "a95", "diesel_premium", ... N ]
++}
++} ... N
++}
++{{/code}}
  **Возможные идентификаторы топлива**
@@ -76,91 +76,118 @@
  == Получение прайс-листа ==
--Внешняя система опрашивает Топаз "Web Офис" для получения прайс-листа **HTTP **запросом на **url **с префиксом **/integration/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
++Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
--В ответ Топаз "Web Офис" дает ответ в формате **JSON**
++В ответ Топаз "Web Офис" дает ответ в формате **JSON**{{{}}}
--{{{{
--  {
--   // идентификатор станции внутри Топаз "Web Офис"
--   string StationId,
--   // идентификатор топлива
--   string ProductId,
--   // цена за 1 литр
--   double Price
--  },
--  …. N
--}}}}
++{{code language="javascript" layout="LINENUMBERS"}}
++{
++ {
++ // идентификатор станции внутри Топаз "Web Офис"
++ string StationId,
++ // идентификатор топлива
++ string ProductId,
++ // цена за 1 литр
++ double Price
++ },
++…. N
++}
++{{/code}}
--**Пример ответа**
--{{{{
-- {“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 Офис" о заказе и их статусах осуществляется **HTTP **запросом на **url **с префиксом **/integration/order **, запрос типа **POST **, timeout 10 секунд.
++Информирование "Топаз-Web Office" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
--**Тело запроса содержит JSON вида Order**
++**Тело запроса содержит JSON вида Order{{{}}}**
--{{{{
-- // идентификатор заказа
-- 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 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}}
--Параметр **OrderType **– тип заказа может принимать следующие значения:
++**Обязательными полями при создании нового заказа являются:**
--* **Money **– заправка на фиксированную сумму, **OrderVolume **– сумма рублей
--* **Liters **– заправка на литры, **OrderVolume **– кол-вол литров
++{{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 **– заправка на литры
++
  Параметр **Status **– статус заказа может принимать следующие значения
  * **OrderCreated **– заказ создан и полностью оплачен
--* **Expire **– статус от АЗС не поступил в течение 30 минут
++* **Accepted **- АЗС готова начать налив
++* **Expired **– статус от АЗС не поступил в течение 30 минут
  * **Completed **– заказа завершен успешно
  * **StationCanceled **– заказ отменен оператором АЗС или же Топаз "Web Офис"
  * **UserCanceled **– заказ отменен пользователем
--
  Параметр **ContractId **– стандартными типами договора, по которому обрабатывается заказ
  * **Individual **– договор возмездного оказания услуг (физические лица)
@@ -174,16 +174,20 @@
  == Передача статусов о заказе ==
--=== Статус Accept ===
++Для получения статусов Интегратору необходимо со своей стороны реализовать сервис для их получения и обработки
--Данный статус сообщает внешней системе о том, что заказ принят и обработан в Топаз "Web Офис"
++=== Статус Accepted ===
--Данный статус Топаз "Web Офис"отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
++Данный статус сообщает внешней системе о том, что заказ принят и обработан в "Топаз-Web Office"
--В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
++Данный статус "Топаз-Web Office" отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
--**базовый url + /api/order/accept POST**
++В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
++**baseUrl + /api/order/accept**
++
++**POST**
++
  **apikey={apikey}&orderId={ordeId}**
  все параметры являются обязательными
@@ -190,14 +190,16 @@
  === Статус Fueling ===
--Данный статус сообщает внешней системе о том, что Топаз "Web Офис" готов запустить колонку (начать пролив)
++Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
--Данный статус Топаз "Web Офис" отсылает перед началом пуска колонки
++Данный статус "Топаз-Web Office" отсылает перед началом пуска колонки
--В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
++В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
--**базовый url + /api/order/fueling POST**
++**baseUrl + /api/order/fueling**
++**POST**
++
  **apikey={apikey}&orderId={ordeId}**
  все параметры являются обязательными
@@ -206,7 +206,7 @@
  Данный статус сообщает внешней системе о том, что заказ следует отменить
--**базовый url + /api/order/canceled**
++**baseUrl + /api/order/canceled**
  **POST**
@@ -220,14 +220,12 @@
  Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
--В случае если внешняя система дала ответ отличный от **200 ОК **, то Топаз "Web Офис" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
++В случае если внешняя система дала ответ отличный от **200 ОК **, то "Топаз-Web Office" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
--**базовый url + /api/order/completed POST**
++**baseUrl + /api/order/completed POST**
--**apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&**
++**apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&extendedDate={extendedDate}**
--**extendedDate={extendedDate}**
--
  все параметры являются обязательными
  **litre **– кол-во пролитых литров, указывается как **double **с разделителем точка **extendedOrderId **– идентификатор заказа в АСУ сети
@@ -236,11 +236,11 @@
  === Отправка счетчика налива ===
--В момент процесса налива Топаз "Web Офис" может сообщать внешней системе статус счетчика налива
++В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива
--Для этого с периодичностью от 5 – 10 секунд Топаз "Web Офис" выполняет следующий запрос
++Для этого с периодичностью от 5 – 10 секунд "Топаз-Web Office" выполняет следующий запрос
--**базовый url + /api/order/volume**
++**baseUrl + /api/order/volume**
  **POST**
@@ -252,12 +252,14 @@
  == Проверка статуса работы станции ==
--Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ url с префиксом
++Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
--**/integration/ping?apikey={apikey}&stationId={stationId}&columnId={columnId}, stationId **– идентификатор станции
++**/ping?apikey={apikey}&stationId={stationId}&columnId={columnId},**
--**columnId **– идентификатор ТРК
++**stationId **– идентификатор станции
++**columnId **– идентификатор стороны ТРК
++
  запрос типа **GET **, timeout 10 секунд.
  == Статусы ответов ==