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

Сводка

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

Подробности

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

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

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

Содержимое

...	...	@@ -2,27 +2,21 @@
2	2
3	3	== Настройка перед интеграцией ==
4	4
5		-Для начала работы необходимо зарегистрироваться в Личном кабинете Интегратора
6	6
7		-~1. Для регистрации пройдите по ссылке: [[https:~~/~~/topazoffice.ru/#/auth/integrator-registration/ef>>https://topazoffice.ru/#/auth/integrator-registration/ef]]
	6	+Перед началом интеграции, уполномоченный сотрудник компании, предоставляющей услуги внешних наливов (далее Интегратор), передает в ООО "Топаз-сервис" следующую информацию:
8	8
9		-2. После ввода логина и пароля на почту будет отправлено письмо для подтверждения регистрации
	8	+1. Базовый url тестового окружения системы внешнего налива
	9	+1. Список ip адресов, с которых будут приходить запросы от тестового окружения системы внешнего налива
	10	+1. Базовый url боевого окружения системы внешнего налива
	11	+1. Список ip адресов, с которых будут приходить запросы от боевого окружения системы внешнего налива
	12	+1. Официальное название системы внешних наливов, которое будет указано в Топаз "Web Офис"
	13	+1. Иконку системы внешних наливов в формате svg с соотношением сторон 1:1
	14	+1. Email, на который будет зарегистрирован личный кабинет интегратора
10	10
11		-3. Перейдите по ссылке из письма для подтверждения учетной записи.
	16	+После получения информации по указанным пунктам, от ООО "Топаз-сервис" будет предоставлен тестовый доступ для настройки интеграции.
12	12
13		-4. Авторизуйтесь в Топаз Web-Office ([[https:~~/~~/topazoffice.ru/#/login>>url:https://topazoffice.ru/#/login]] )
	18	+Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в "Топаз-Web Office".
14	14
15		-5. В открывшейся форме заполните поля:
16		-
17		-* Официальное название системы внешних наливов, которое будет указано в Топаз "Web Офис"
18		-* Прикрепите иконку Вашей системы  в формате svg с соотношением сторон 1:1. Эти название и иконку будут видеть конечные клиенты  в Топаз "Web Офис"
19		-* Базовый url тестового окружения системы внешнего налива
20		-* Список ip адресов, с которых будут приходить запросы от тестового окружения системы внешнего налива
21		-* Базовый url боевого окружения системы внешнего налива
22		-* Список ip адресов, с которых будут приходить запросы от боевого окружения системы внешнего налива
23		-
24		-6. Нажмите на кнопку "Создать", после этого вы получите уникальный API-ключ, он отобразится в соответствующем поле.
25		-
26	26	(% class="box errormessage" %)
27	27	(((
28	28	(% class="wikigeneratedid" id="H41443043D43D44B43943A43B44E44743D43543E43144543E43443843C43E43144343443544243F43544043543443043243044244C43243E43244143544543743043F44043E44143044543E44243243D43544843D43543944143844144243543C44B4322242243E43F430437-WebOffice2243243743043343E43B43E43243A43528header29externalSystemApikey" %)
...	...	@@ -43,7 +43,7 @@
43	43
44	44	----
45	45
46		-== **Методы API "Топаз-Web Офис":** ==
	40	+== **Методы API "Топаз-Web Office":** ==
47	47
48	48	1. **Получение списка АЗС и их конфигураций**
49	49	1. **Получение прайс-листа**
...	...	@@ -236,8 +236,9 @@
236	236
237	237	== Отмена заказа ==
238	238
239		-Отмена заказа возможна даже после его старта. Для инициации отмены необходимо отправить тот же заказ со статусом (% style="background-color:#dddddd; font-family:Courier New,Courier,monospace" %)**UserCanceled**(%%). Если на момент получения запроса на отмену процесс налива ещё не начался, заказ будет отменён.
	233	+Отмена заказа возможна даже после его старта. Для инициации отмены необходимо отправить тот же заказ со статусом (% style="font-family: Courier New, Courier, monospace; background-color: rgb(221, 221, 221)" %)**UserCanceled**(%%). Если на момент получения запроса на отмену процесс налива ещё не начался, заказ будет отменён.
240	240
	235	+
241	241	В случае, если отмена инициирована после начала налива, система остановит процесс пролива и зафиксирует заказ как отменённый. В этом случае в ответе будет указано количество литров, фактически налитых до момента остановки.
242	242
243	243
...	...	@@ -269,25 +269,14 @@
269	269
270	270	== **Методы REST API интегратора (внешней системы):** ==
271	271
272		-
273		-
274		-=== Получение статусов от Топаз Web-офис ===
275		-
276		-
277		-
278	278	1. **Статус Accepted**
279	279	1. **Статус Fueling**
280	280	1. **Статус Canceled**
281	281	1. **Статус Completed**
282		-1. **Отправка счетчика налива Volume**
	271	+1. **Отправка счетчика налива**
283	283
284	284	Данные запросы "Топаз-Web Office" отправляет Интегратору.
285	285
286		-(% class="box infomessage" %)
287		-(((
288		-##**Все методы, отправляющие статусы заказа (**##**Accepted, Fueling, Canceled, Completed, Volume),## отправляют данные в теле в формате x-www-form-urlencoded##**
289		-)))
290		-
291	291	=== **Статус Accepted** ===
292	292
293	293	Данный статус сообщает внешней системе о том, что заказ принят и обработан в "Топаз-Web Office"
...	...	@@ -348,16 +348,12 @@
348	348
349	349	**baseUrl + /api/order/completed POST**
350	350
351		-**apikey={apikey}&orderId={ordeId}&litre={litre}&summ={summ}&extendedOrderId={extendedOrderId}&extendedDate={extendedDate}**
	335	+**apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&extendedDate={extendedDate}**
352	352
353	353	все параметры являются обязательными
354	354
355		-**litre **– кол-во пролитых литров, указывается как **double **с разделителем точка,
	339	+**litre **– кол-во пролитых литров, указывается как **double **с разделителем точка **extendedOrderId **– идентификатор заказа в АСУ сети
356	356
357		-**summ **- итоговая сумма заказа,
358		-
359		-**extendedOrderId **– идентификатор заказа в АСУ сети
360		-
361	361	**extendedDate **– дата по которой АСУ строит отчет для сверки, формат **dd.MM.yyyy HH:mm:ss**
362	362
363	363	=== ===
...	...	@@ -377,10 +377,3 @@
377	377	все параметры являются обязательными
378	378
379	379	**litre **– кол-во пролитых на момент отправки запроса литров, указывается как double с разделителем точка
380		-
381		-
382		-=== Отправка статусов в Топаз Web Офис ===
383		-
384		-Для согласованности заказов после каждого полученного статуса от Топаз Web Офис необходимо отправить статус в системе Интегратора.
385		-Для этого необходимо повторить запрос **/order, **с измененными полями **OrderStatus, **в соответствии с состоянием заказа в системе Интегратора.
386		-При отправке статуса **Completed **допускается присылать размер реально налитых литров и оплаченных средств **LitreCompleted, SumPaidCompleted**