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

Сводка

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

Подробности

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

Содержимое

...	...	@@ -3,7 +3,7 @@
3	3	== Настройка перед интеграцией ==
4	4
5	5
6		-Перед началом интеграции, уполномоченный сотрудник компании, предоставляющей услуги внешних наливов, передает в ООО "Топаз-сервис" следующую информацию:
	6	+Перед началом интеграции, уполномоченный сотрудник компании, предоставляющей услуги внешних наливов (далее Интегратор), передает в ООО "Топаз-сервис" следующую информацию:
7	7
8	8	1. Базовый url тестового окружения системы внешнего налива
9	9	1. Список ip адресов, с которых будут приходить запросы от тестового окружения системы внешнего налива
...	...	@@ -14,8 +14,19 @@
14	14
15	15	После получения информации по указанным пунктам, от ООО "Топаз-сервис" будет предоставлен тестовый доступ для настройки интеграции.
16	16
17		-Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в Топаз "Web Офис". Данный ключ необходимо будет передавать во всех запросах от внешней системы в Топаз "Web Офис" в заголовке externalSystemApikey
	17	+Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в "Топаз-Web Office".
18	18
	19	+(% class="box errormessage" %)
	20	+(((
	21	+=== **Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey** ===
	22	+)))
	23	+
	24	+== ApiKey ==
	25	+
	26	+(% class="wikigeneratedid" %)
	27	+Интегратору необходимо для каждого своего клиента (сети АЗС) сформировать и хранить в собственной базе данных уникальный Apikey.
	28	+С помощью этого Apikey происходит идентификация клиента (сети АЗС) при обмене между "Топаз-Web Office" и системой Интегратора.
	29	+
19	19	== Адрес для отправки запросов ==
20	20
21	21	Базовым адресом **(baseUrl)** для выполнения запросов является [[https:~~/~~/topazoffice.ru/ms/external-fueling/integration>>https://topazoffice.ru/ms/external-fueling/integration]]
...	...	@@ -22,7 +22,7 @@
22	22
23	23	== Получение списка АЗС и их конфигураций ==
24	24
25		-Внешняя система опрашивает Топаз "Web Офис" для получения списка АЗС и их конфигураций **через HTTP **запрос на **baseUrl **с префиксом **/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
	36	+Внешняя система опрашивает "Топаз-Web Office" для получения списка АЗС и их конфигураций **через HTTP **запрос на **baseUrl **с префиксом **/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.
26	26
27	27	В ответ Топаз "Web Офис" дает ответ в формате **JSON**
28	28
...	...	@@ -74,7 +74,7 @@
74	74
75	75	== Получение прайс-листа ==
76	76
77		-Внешняя система опрашивает Топаз "Web Офис" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
	88	+Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.
78	78
79	79	В ответ Топаз "Web Офис" дает ответ в формате **JSON**{{{}}}
80	80
...	...	@@ -108,7 +108,7 @@
108	108
109	109	[[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2]]
110	110
111		-Информирование Топаз "Web Офис" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
	122	+Информирование "Топаз-Web Office" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.
112	112
113	113
114	114	**Тело запроса содержит JSON вида Order**{{{}}}
...	...	@@ -180,11 +180,11 @@
180	180
181	181	=== Статус Accept ===
182	182
183		-Данный статус сообщает внешней системе о том, что заказ принят и обработан в Топаз "Web Офис"
	194	+Данный статус сообщает внешней системе о том, что заказ принят и обработан в "Топаз-Web Office"
184	184
185		-Данный статус Топаз "Web Офис"отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
	196	+Данный статус "Топаз-Web Office" отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
186	186
187		-В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
	198	+В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
188	188
189	189	**baseUrl + /api/order/accept POST**
190	190
...	...	@@ -194,11 +194,11 @@
194	194
195	195	=== Статус Fueling ===
196	196
197		-Данный статус сообщает внешней системе о том, что Топаз "Web Офис" готов запустить колонку (начать пролив)
	208	+Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
198	198
199		-Данный статус Топаз "Web Офис" отсылает перед началом пуска колонки
	210	+Данный статус "Топаз-Web Office" отсылает перед началом пуска колонки
200	200
201		-В случае если внешняя система дала ответ, отличный от **200 ОК **, то Топаз "Web Офис" отсылает статус Canceled и прекращает обработку заказ
	212	+В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
202	202
203	203	**baseUrl + /api/order/fueling POST**
204	204
...	...	@@ -224,7 +224,7 @@
224	224
225	225	Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
226	226
227		-В случае если внешняя система дала ответ отличный от **200 ОК **, то Топаз "Web Офис" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
	238	+В случае если внешняя система дала ответ отличный от **200 ОК **, то "Топаз-Web Office" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**
228	228
229	229	**baseUrl + /api/order/completed POST**
230	230
...	...	@@ -240,9 +240,9 @@
240	240
241	241	=== Отправка счетчика налива ===
242	242
243		-В момент процесса налива Топаз "Web Офис" может сообщать внешней системе статус счетчика налива
	254	+В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива
244	244
245		-Для этого с периодичностью от 5 – 10 секунд Топаз "Web Офис" выполняет следующий запрос
	256	+Для этого с периодичностью от 5 – 10 секунд "Топаз-Web Office" выполняет следующий запрос
246	246
247	247	**baseUrl + /api/order/volume**
248	248