Перейти к содержимому
Редактировал(а) Dmitriy 2026/04/23 06:18
От версии 40.1
отредактировано Ярослава Ерина
на 2026/01/16 11:04
Изменить комментарий: К данной версии нет комментариев
К версии 52.1
отредактировано Dmitriy
на 2026/04/23 06:18
Изменить комментарий: К данной версии нет комментариев

Сводка

Подробности

Свойства страницы
Автор документа
... ... @@ -1,1 +1,1 @@
1 -XWiki.erina_jv
1 +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 -Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в "Топаз-Web Office".
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. **Получение прайс-листа**
... ... @@ -228,6 +228,13 @@
228 228  **FuelId **+ **PriceFuel **– в случае если стоимость топлива в Топаз "Web Офис" отличается от присланной, то Топаз "Web Офис" дает ответ **402.**
229 229  
230 230  
237 +== Отмена заказа ==
238 +
239 +Отмена заказа возможна даже после его старта. Для инициации отмены необходимо отправить тот же заказ со статусом (% style="background-color:#dddddd; font-family:Courier New,Courier,monospace" %)**UserCanceled**(%%). Если на момент получения запроса на отмену процесс налива ещё не начался, заказ будет отменён.
240 +
241 +В случае, если отмена инициирована после начала налива, система остановит процесс пролива и зафиксирует заказ как отменённый. В этом случае в ответе будет указано количество литров, фактически налитых до момента остановки.
242 +
243 +
231 231  == Проверка статуса работы станции ==
232 232  
233 233  Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом
... ... @@ -256,14 +256,25 @@
256 256  
257 257  == **Методы REST API интегратора (внешней системы):** ==
258 258  
272 +
273 +
274 +=== Получение статусов от Топаз Web-офис ===
275 +
276 +
277 +
259 259  1. **Статус Accepted**
260 260  1. **Статус Fueling**
261 261  1. **Статус Canceled**
262 262  1. **Статус Completed**
263 -1. **Отправка счетчика налива**
282 +1. **Отправка счетчика налива Volume**
264 264  
265 265  Данные запросы "Топаз-Web Office" отправляет Интегратору.
266 266  
286 +(% class="box infomessage" %)
287 +(((
288 +##**Все методы, отправляющие статусы заказа (**##**Accepted, Fueling, Canceled, Completed, Volume),## отправляют данные в теле в формате x-www-form-urlencoded##**
289 +)))
290 +
267 267  === **Статус Accepted** ===
268 268  
269 269  Данный статус сообщает внешней системе о том, что заказ принят и обработан в "Топаз-Web Office"
... ... @@ -324,12 +324,16 @@
324 324  
325 325  **baseUrl + /api/order/completed POST**
326 326  
327 -**apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&extendedDate={extendedDate}**
351 +**apikey={apikey}&orderId={ordeId}&litre={litre}&summ={summ}&extendedOrderId={extendedOrderId}&extendedDate={extendedDate}**
328 328  
329 329  все параметры являются обязательными
330 330  
331 -**litre **– кол-во пролитых литров, указывается как **double **с разделителем точка **extendedOrderId **– идентификатор заказа в АСУ сети
355 +**litre **– кол-во пролитых литров, указывается как **double **с разделителем точка,
332 332  
357 +**summ **- итоговая сумма заказа,
358 +
359 +**extendedOrderId **– идентификатор заказа в АСУ сети
360 +
333 333  **extendedDate **– дата по которой АСУ строит отчет для сверки, формат **dd.MM.yyyy HH:mm:ss**
334 334  
335 335  === ===
... ... @@ -349,3 +349,10 @@
349 349  все параметры являются обязательными
350 350  
351 351  **litre **– кол-во пролитых на момент отправки запроса литров, указывается как double с разделителем точка
380 +
381 +
382 +=== Отправка статусов в Топаз Web Офис ===
383 +
384 +Для согласованности заказов после каждого полученного статуса от Топаз Web Офис необходимо отправить статус в системе Интегратора.
385 +Для этого необходимо повторить запрос **/order, **с измененными полями **OrderStatus, **в соответствии с состоянием заказа в системе Интегратора.
386 +При отправке статуса **Completed **допускается присылать размер реально налитых литров и оплаченных средств **LitreCompleted, SumPaidCompleted**