Изменения документа Протокол интеграции систем внешних наливов с Топаз "Web Офис"
Редактировал(а) Dmitriy 2026/04/23 06:18
От версии 42.1
отредактировано Ярослава Ерина
на 2026/01/16 12:40
на 2026/01/16 12:40
Изменить комментарий:
К данной версии нет комментариев
Сводка
-
Свойства страницы (2 изменено, 0 добавлено, 0 удалено)
Подробности
- Свойства страницы
-
- Автор документа
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki.erin a_jv1 +XWiki.erin_ds - Содержимое
-
... ... @@ -2,21 +2,27 @@ 2 2 3 3 == Настройка перед интеграцией == 4 4 5 +Для начала работы необходимо зарегистрироваться в Личном кабинете Интегратора 5 5 6 - Передначаломинтеграции, уполномоченныйсотрудник компании,предоставляющейуслуги внешних наливов (далее Интегратор),передает в ООО "Топаз-сервис"следующуюинформацию:7 +~1. Для регистрации пройдите по ссылке: [[https:~~/~~/topazoffice.ru/#/auth/integrator-registration/ef>>https://topazoffice.ru/#/auth/integrator-registration/ef]] 7 7 8 -1. Базовый url тестового окружения системы внешнего налива 9 -1. Список ip адресов, с которых будут приходить запросы от тестового окружения системы внешнего налива 10 -1. Базовый url боевого окружения системы внешнего налива 11 -1. Список ip адресов, с которых будут приходить запросы от боевого окружения системы внешнего налива 12 -1. Официальное название системы внешних наливов, которое будет указано в Топаз "Web Офис" 13 -1. Иконку системы внешних наливов в формате svg с соотношением сторон 1:1 14 -1. Email, на который будет зарегистрирован личный кабинет интегратора 9 +2. После ввода логина и пароля на почту будет отправлено письмо для подтверждения регистрации 15 15 16 -П ослеполученияинформациипоуказанным пунктам,отООО "Топаз-сервис"будетпредоставлентестовый доступ длянастройкиинтеграции.11 +3. Перейдите по ссылке из письма для подтверждения учетной записи. 17 17 18 - Такжебудетпредоставлен секретныйключ (тестовогои боевогоокружения) для идентификации системы внешних наливов в "Топаз-WebOffice".13 +4. Авторизуйтесь в Топаз Web-Office ([[https:~~/~~/topazoffice.ru/#/login>>url:https://topazoffice.ru/#/login]] ) 19 19 15 +5. В открывшейся форме заполните поля: 16 + 17 +* Официальное название системы внешних наливов, которое будет указано в Топаз "Web Офис" 18 +* Прикрепите иконку Вашей системы в формате svg с соотношением сторон 1:1. Эти название и иконку будут видеть конечные клиенты в Топаз "Web Офис" 19 +* Базовый url тестового окружения системы внешнего налива 20 +* Список ip адресов, с которых будут приходить запросы от тестового окружения системы внешнего налива 21 +* Базовый url боевого окружения системы внешнего налива 22 +* Список ip адресов, с которых будут приходить запросы от боевого окружения системы внешнего налива 23 + 24 +6. Нажмите на кнопку "Создать", после этого вы получите уникальный API-ключ, он отобразится в соответствующем поле. 25 + 20 20 (% class="box errormessage" %) 21 21 ((( 22 22 (% class="wikigeneratedid" id="H41443043D43D44B43943A43B44E44743D43543E43144543E43443843C43E43144343443544243F43544043543443043243044244C43243E43244143544543743043F44043E44143044543E44243243D43544843D43543944143844144243543C44B4322242243E43F430437-WebOffice2243243743043343E43B43E43243A43528header29externalSystemApikey" %) ... ... @@ -37,7 +37,7 @@ 37 37 38 38 ---- 39 39 40 -== **Методы API "Топаз-Web Office":** ==46 +== **Методы API "Топаз-Web Офис":** == 41 41 42 42 1. **Получение списка АЗС и их конфигураций** 43 43 1. **Получение прайс-листа** ... ... @@ -263,14 +263,25 @@ 263 263 264 264 == **Методы REST API интегратора (внешней системы):** == 265 265 272 + 273 + 274 +=== Получение статусов от Топаз Web-офис === 275 + 276 + 277 + 266 266 1. **Статус Accepted** 267 267 1. **Статус Fueling** 268 268 1. **Статус Canceled** 269 269 1. **Статус Completed** 270 -1. **Отправка счетчика налива** 282 +1. **Отправка счетчика налива Volume** 271 271 272 272 Данные запросы "Топаз-Web Office" отправляет Интегратору. 273 273 286 +(% class="box infomessage" %) 287 +((( 288 +##**Все методы, отправляющие статусы заказа (**##**Accepted, Fueling, Canceled, Completed, Volume),## отправляют данные в теле в формате x-www-form-urlencoded##** 289 +))) 290 + 274 274 === **Статус Accepted** === 275 275 276 276 Данный статус сообщает внешней системе о том, что заказ принят и обработан в "Топаз-Web Office" ... ... @@ -331,12 +331,16 @@ 331 331 332 332 **baseUrl + /api/order/completed POST** 333 333 334 -**apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&extendedDate={extendedDate}** 351 +**apikey={apikey}&orderId={ordeId}&litre={litre}&summ={summ}&extendedOrderId={extendedOrderId}&extendedDate={extendedDate}** 335 335 336 336 все параметры являются обязательными 337 337 338 -**litre **– кол-во пролитых литров, указывается как **double **с разделителем точка **extendedOrderId **– идентификатор заказа в АСУ сети355 +**litre **– кол-во пролитых литров, указывается как **double **с разделителем точка, 339 339 357 +**summ **- итоговая сумма заказа, 358 + 359 +**extendedOrderId **– идентификатор заказа в АСУ сети 360 + 340 340 **extendedDate **– дата по которой АСУ строит отчет для сверки, формат **dd.MM.yyyy HH:mm:ss** 341 341 342 342 === === ... ... @@ -356,3 +356,10 @@ 356 356 все параметры являются обязательными 357 357 358 358 **litre **– кол-во пролитых на момент отправки запроса литров, указывается как double с разделителем точка 380 + 381 + 382 +=== Отправка статусов в Топаз Web Офис === 383 + 384 +Для согласованности заказов после каждого полученного статуса от Топаз Web Офис необходимо отправить статус в системе Интегратора. 385 +Для этого необходимо повторить запрос **/order, **с измененными полями **OrderStatus, **в соответствии с состоянием заказа в системе Интегратора. 386 +При отправке статуса **Completed **допускается присылать размер реально налитых литров и оплаченных средств **LitreCompleted, SumPaidCompleted**