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

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

От 26.1 до 27.1 От 49.1 до 50.1

От версии 27.1

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

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

К версии 49.1

отредактировано Dmitriy
на 2026/04/13 12:45

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

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

Сводка

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

Подробности

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

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

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

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

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

Содержимое

@@ -1,27 +3,35 @@
--{{toc/}}
--
  v 1.0.1
  == Настройка перед интеграцией ==
++Для начала работы необходимо зарегистрироваться в Личном кабинете Интегратора
--Перед началом интеграции, уполномоченный сотрудник компании, предоставляющей услуги внешних наливов (далее Интегратор), передает в ООО "Топаз-сервис" следующую информацию:
++~1. Для регистрации пройдите по ссылке: [[https:~~/~~/topazoffice.ru/#/auth/integrator-registration/ef>>https://topazoffice.ru/#/auth/integrator-registration/ef]]
--1. Базовый url тестового окружения системы внешнего налива
--1. Список ip адресов, с которых будут приходить запросы от тестового окружения системы внешнего налива
--1. Базовый url боевого окружения системы внешнего налива
--1. Список ip адресов, с которых будут приходить запросы от боевого окружения системы внешнего налива
--1. Официальное название системы внешних наливов, которое будет указано в Топаз "Web Офис"
--1. Иконку системы внешних наливов в формате svg с соотношением сторон 1:1
++2. После ввода логина и пароля на почту будет отправлено письмо для подтверждения регистрации
--После получения информации по указанным пунктам, от ООО "Топаз-сервис" будет предоставлен тестовый доступ для настройки интеграции.
++3. Перейдите по ссылке из письма для подтверждения учетной записи.
--Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в "Топаз-Web Office".
++4. Авторизуйтесь в Топаз Web-Office ([[https:~~/~~/topazoffice.ru/#/login>>url:https://topazoffice.ru/#/login]] )
++5. В открывшейся форме заполните поля:
++
++* Официальное название системы внешних наливов, которое будет указано в Топаз "Web Офис"
++* Прикрепите иконку Вашей системы  в формате svg с соотношением сторон 1:1. Эти название и иконку будут видеть конечные клиенты  в Топаз "Web Офис"
++* Базовый url тестового окружения системы внешнего налива
++* Список ip адресов, с которых будут приходить запросы от тестового окружения системы внешнего налива
++* Базовый url боевого окружения системы внешнего налива
++* Список ip адресов, с которых будут приходить запросы от боевого окружения системы внешнего налива
++
++6. Нажмите на кнопку "Создать", после этого вы получите уникальный API-ключ, он отобразится в соответствующем поле.
++
  (% class="box errormessage" %)
  (((
++(% class="wikigeneratedid" id="H41443043D43D44B43943A43B44E44743D43543E43144543E43443843C43E43144343443544243F43544043543443043243044244C43243E43244143544543743043F44043E44143044543E44243243D43544843D43543944143844144243543C44B4322242243E43F430437-WebOffice2243243743043343E43B43E43243A43528header29externalSystemApikey" %)
++(((
  === **Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey** ===
  )))
++)))
  == ApiKey ==
@@ -33,6 +33,7 @@
  Базовым адресом **(baseUrl)** для выполнения запросов является  [[https:~~/~~/topazoffice.ru/ms/external-fueling/integration>>https://topazoffice.ru/ms/external-fueling/integration]]
++----
  == **Методы API "Топаз-Web Office":** ==
@@ -52,25 +52,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
  }
@@ -78,7 +78,8 @@
  **Возможные идентификаторы топлива**
--|ID|Марка
++(% border="1" %)
++|(% style="background-color:#e5e4e2; border-color:black" %)ID|(% style="background-color:#e5e4e2; border-color:black" %)Марка
  |diesel|дизель
  |diesel_premium|брендированный дизель
  |a80|бензин марки А80
@@ -93,6 +93,8 @@
  |propane|газ пропан
  |metan|метан
++==  ==
++
  == Получение прайс-листа ==
  Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
@@ -103,34 +103,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"}}
@@ -137,10 +137,12 @@
  {
  // Идентификатор заказа
  String Id
--// дата и время создания в UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
++// дата и время создания в UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z', yyyy-MM-dd'T'HH:mm:ss.SSS'Z', либо yyyy-MM-dd HH:mm:ss
  String DateCreate
  // идентификатор станции АЗС
  String StationExtendedId
++// Идентификатор АЗС в системе Интегратора (Необязательное поле)
++String StationId
  // Тип заказа
  String OrderType
  // номер стороны (поста)
@@ -157,7 +157,7 @@
  double SumPaid
  // Статус заказа
  OrderStatus Status
--// дата и время завершения заказа UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
++// дата и время завершения заказа UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z', yyyy-MM-dd'T'HH:mm:ss.SSS'Z', либо yyyy-MM-dd HH:mm:ss
  String DateEnd
  // Идентификатор причины отмены заказа
  String ReasonId
@@ -218,6 +218,13 @@
  **FuelId **+ **PriceFuel **– в случае если стоимость топлива в Топаз "Web Офис" отличается от присланной, то Топаз "Web Офис" дает ответ **402.**
++== Отмена заказа ==
++
++Отмена заказа возможна даже после его старта. Для инициации отмены необходимо отправить тот же заказ со статусом (% style="background-color:#dddddd; font-family:Courier New,Courier,monospace" %)**UserCanceled**(%%). Если на момент получения запроса на отмену процесс налива ещё не начался, заказ будет отменён.
++
++В случае, если отмена инициирована после начала налива, система остановит процесс пролива и зафиксирует заказ как отменённый. В этом случае в ответе будет указано количество литров, фактически налитых до момента остановки.
++
++
  == Проверка статуса работы станции ==
  Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
@@ -234,8 +234,10 @@
  **200 ОК **– станция и ТРК готова принять и обработать заказ
--**400 **– станция или ТРК не найдена (не верный идентификатор станции или ТРК) **404 **– ТРК занята / ТРК не готова принять заказ
++**400 **– станция или ТРК не найдена (неверный идентификатор станции или ТРК)
++**404 **– ТРК занята / ТРК не готова принять заказ
++
  любой ответ не **200 ОК **– интерпретируется как на станции нет интернета / станция не доступна
  ----
@@ -248,10 +248,15 @@
 . **Статус Fueling**
 . **Статус Canceled**
 . **Статус Completed**
--1. **Отправка счетчика налива**
++1. **Отправка счетчика налива Volume**
  Данные запросы "Топаз-Web Office" отправляет Интегратору.
++(% class="box infomessage" %)
++(((
++##**Все методы, отправляющие статусы заказа (**##**Accepted, Fueling, Canceled, Completed, Volume),## отправляют данные в теле в формате x-www-form-urlencoded##**
++)))
++
  === **Статус Accepted** ===
  Данный статус сообщает внешней системе о том, что заказ принят и обработан в "Топаз-Web Office"
@@ -268,6 +268,8 @@
  все параметры являются обязательными
++===  ===
++
  === **Статус Fueling** ===
  Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
@@ -284,6 +284,8 @@
  все параметры являются обязательными
++===  ===
++
  === **Статус Canceled** ===
  Данный статус сообщает внешней системе о том, что заказ следует отменить
@@ -298,6 +298,8 @@
  **reason – **текстовая причина отмены
++===  ===
++
  === **Статус Completed** ===
  Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
@@ -314,6 +314,8 @@
  **extendedDate **– дата по которой АСУ строит отчет для сверки, формат **dd.MM.yyyy HH:mm:ss**
++===  ===
++
  === **Отправка счетчика налива** ===
  В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива