Перейти к содержимому
Редактировал(а) Dmitriy 2026/04/23 06:18
От версии 36.2
отредактировано Ярослава Ерина
на 2025/01/17 07:38
Изменить комментарий: Update document after refactoring.
К версии 46.1
отредактировано Ярослава Ерина
на 2026/02/09 11:56
Изменить комментарий: К данной версии нет комментариев

Сводка

Подробности

Свойства страницы
Родительский документ
... ... @@ -1,1 +1,1 @@
1 -Внешние API.Внешние наливы.WebHome
1 +vneshnie_api.vneshnie_nalivy2.WebHome
Содержимое
... ... @@ -2,20 +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
9 +2. После ввода логина и пароля на почту будет отправлено письмо для подтверждения регистрации
14 14  
15 -После получения информации по указанным пунктам, от ООО "Топаз-сервис" будет предоставлен тестовый доступ для настройки интеграции.
11 +3. Перейдите по ссылке из письма для подтверждения учетной записи.
16 16  
17 -Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в "Топаз-Web Office".
13 +4. Авторизуйтесь в Топаз Web-Office ([[https:~~/~~/topazoffice.ru/#/login>>url:https://topazoffice.ru/#/login]] )
18 18  
15 +5. В открывшейся форме заполните поля:
16 +
17 +* Официальное название системы внешних наливов, которое будет указано в Топаз "Web Офис"
18 +* Прикрепите иконку Вашей системы  в формате svg с соотношением сторон 1:1. Эти название и иконку будут видеть конечные клиенты  в Топаз "Web Офис"
19 +* Базовый url тестового окружения системы внешнего налива
20 +* Список ip адресов, с которых будут приходить запросы от тестового окружения системы внешнего налива
21 +* Базовый url боевого окружения системы внешнего налива
22 +* Список ip адресов, с которых будут приходить запросы от боевого окружения системы внешнего налива
23 +
24 +6. Нажмите на кнопку "Создать", после этого вы получите уникальный API-ключ, он отобразится в соответствующем поле.
25 +
19 19  (% class="box errormessage" %)
20 20  (((
21 21  (% class="wikigeneratedid" id="H41443043D43D44B43943A43B44E44743D43543E43144543E43443843C43E43144343443544243F43544043543443043243044244C43243E43244143544543743043F44043E44143044543E44243243D43544843D43543944143844144243543C44B4322242243E43F430437-WebOffice2243243743043343E43B43E43243A43528header29externalSystemApikey" %)
... ... @@ -54,25 +54,25 @@
54 54  {{code language="javascript" layout="LINENUMBERS"}}
55 55  {
56 56  // идентификатор станции АЗС
57 -string Id
64 +string id
58 58  // статус станции: true – доступна, false – выключена
59 -bool Enable,
66 +bool enable,
60 60  // наименование станции
61 -string Name,
68 +string name,
62 62  // адрес станции
63 -string Address,
70 +string address,
64 64  // гео точка на карте
65 -location Location
72 +location location
66 66  {
67 -double Lat,
68 -double Lon },
74 +double lat,
75 +double lon },
69 69  // словарь доступных ТРК
70 -Dictionary Columns {
77 +Dictionary columns {
71 71  // номер колонки
72 72  (int32) Key:
73 73  {
74 74  // список доступных типов топлива
75 -"Fuels": [ "a92", "a95", "diesel_premium", ... N ]
82 +"fuels": [ "a92", "a95", "diesel_premium", ... N ]
76 76  }
77 77  } ... N
78 78  }
... ... @@ -108,11 +108,13 @@
108 108  {
109 109   {
110 110   // идентификатор станции внутри Топаз "Web Офис"
111 - string StationId,
118 + string stationId,
112 112   // идентификатор топлива
113 - string ProductId,
120 + string productId,
114 114   // цена за 1 литр
115 - double Price
122 + double price
123 + // Внешний код топлива
124 + string fuelExtendedId
116 116   },
117 117  …. N
118 118  }
... ... @@ -122,9 +122,9 @@
122 122  
123 123  {{code language="javascript"}}
124 124  {
125 -{"StationId": "0001", "ProductId": "a92", "Price": 38.66},
126 -{"StationId": "0001", "ProductId": "a95_premium", "Price": 45.21},
127 -{"StationId": "0002", "ProductId": "a92", "Price": 38.98},
134 +{"stationId": "0001", "productId": "a92", "price": 38.66, "fuelExtendedId": "92"},
135 +{"stationId": "0001", "productId": "a95_premium", "price": 45.21, "fuelExtendedId": "95"},
136 +{"stationId": "0002", "productId": "a92", "price": 38.98, , "fuelExtendedId": "92"},
128 128  }
129 129  {{/code}}
130 130  
... ... @@ -142,10 +142,12 @@
142 142  {
143 143  // Идентификатор заказа
144 144  String Id
145 -// дата и время создания в UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
154 +// дата и время создания в 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
146 146  String DateCreate
147 147  // идентификатор станции АЗС
148 148  String StationExtendedId
158 +// Идентификатор АЗС в системе Интегратора (Необязательное поле)
159 +String StationId
149 149  // Тип заказа
150 150  String OrderType
151 151  // номер стороны (поста)
... ... @@ -162,7 +162,7 @@
162 162  double SumPaid
163 163  // Статус заказа
164 164  OrderStatus Status
165 -// дата и время завершения заказа UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
176 +// дата и время завершения заказа 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
166 166  String DateEnd
167 167  // Идентификатор причины отмены заказа
168 168  String ReasonId
... ... @@ -223,6 +223,13 @@
223 223  **FuelId **+ **PriceFuel **– в случае если стоимость топлива в Топаз "Web Офис" отличается от присланной, то Топаз "Web Офис" дает ответ **402.**
224 224  
225 225  
237 +== Отмена заказа ==
238 +
239 +Отмена заказа возможна даже после его старта. Для инициации отмены необходимо отправить тот же заказ со статусом (% style="background-color:#dddddd; font-family:Courier New,Courier,monospace" %)**UserCanceled**(%%). Если на момент получения запроса на отмену процесс налива ещё не начался, заказ будет отменён.
240 +
241 +В случае, если отмена инициирована после начала налива, система остановит процесс пролива и зафиксирует заказ как отменённый. В этом случае в ответе будет указано количество литров, фактически налитых до момента остановки.
242 +
243 +
226 226  == Проверка статуса работы станции ==
227 227  
228 228  Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом