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

Версия 36.1 от Ярослава Ерина на 2024/12/11 13:33

version	line-number	content
27.1	1	v 1.0.1
	2
1.1	3	== Настройка перед интеграцией ==
	4
	5
19.1	6	Перед началом интеграции, уполномоченный сотрудник компании, предоставляющей услуги внешних наливов (далее Интегратор), передает в ООО "Топаз-сервис" следующую информацию:
1.1	7
	8	1. Базовый url тестового окружения системы внешнего налива
	9	1. Список ip адресов, с которых будут приходить запросы от тестового окружения системы внешнего налива
	10	1. Базовый url боевого окружения системы внешнего налива
	11	1. Список ip адресов, с которых будут приходить запросы от боевого окружения системы внешнего налива
	12	1. Официальное название системы внешних наливов, которое будет указано в Топаз "Web Офис"
	13	1. Иконку системы внешних наливов в формате svg с соотношением сторон 1:1
	14
	15	После получения информации по указанным пунктам, от ООО "Топаз-сервис" будет предоставлен тестовый доступ для настройки интеграции.
	16
19.1	17	Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в "Топаз-Web Office".
1.1	18
18.1	19	(% class="box errormessage" %)
	20	(((
28.1	21	(% class="wikigeneratedid" id="H41443043D43D44B43943A43B44E44743D43543E43144543E43443843C43E43144343443544243F43544043543443043243044244C43243E43244143544543743043F44043E44143044543E44243243D43544843D43543944143844144243543C44B4322242243E43F430437-WebOffice2243243743043343E43B43E43243A43528header29externalSystemApikey" %)
	22	(((
34.1	23	=== Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey ===
18.1	24	)))
28.1	25	)))
18.1	26
20.1	27	== ApiKey ==
19.1	28
	29	(% class="wikigeneratedid" %)
	30	Интегратору необходимо для каждого своего клиента (сети АЗС) сформировать и хранить в собственной базе данных уникальный Apikey.
	31	С помощью этого Apikey происходит идентификация клиента (сети АЗС) при обмене между "Топаз-Web Office" и системой Интегратора.
	32
15.1	33	== Адрес для отправки запросов ==
	34
16.1	35	Базовым адресом (baseUrl) для выполнения запросов является [[https:~~/~~/topazoffice.ru/ms/external-fueling/integration>>https://topazoffice.ru/ms/external-fueling/integration]]
15.1	36
33.1	37	----
24.1	38
	39	== Методы API "Топаз-Web Office": ==
	40
30.1	41	1. Получение списка АЗС и их конфигураций
24.1	42	1. Получение прайс-листа
	43	1. Получение и обработка заказа
	44	1. Проверка статуса работы станции
	45
1.1	46	== Получение списка АЗС и их конфигураций ==
	47
19.1	48	Внешняя система опрашивает "Топаз-Web Office" для получения списка АЗС и их конфигураций через HTTP запрос на baseUrl с префиксом /station?apikey={apikey }, запрос типа GET , timeout 10 секунд.
1.1	49
	50	В ответ Топаз "Web Офис" дает ответ в формате JSON
	51
	52	...
	53
22.1	54	{{code language="javascript" layout="LINENUMBERS"}}
11.1	55	{
9.2	56	// идентификатор станции АЗС
	57	string Id
	58	// статус станции: true – доступна, false – выключена
	59	bool Enable,
	60	// наименование станции
	61	string Name,
	62	// адрес станции
	63	string Address,
	64	// гео точка на карте
	65	location Location
6.1	66	{
9.2	67	double Lat,
	68	double Lon },
	69	// словарь доступных ТРК
	70	Dictionary Columns {
	71	// номер колонки
	72	(int32) Key:
	73	{
6.1	74	// список доступных типов топлива
	75	"Fuels": [ "a92", "a95", "diesel_premium", ... N ]
	76	}
	77	} ... N
11.1	78	}
	79	{{/code}}
1.1	80
	81	Возможные идентификаторы топлива
	82
35.1	83	(% border="1" %)
36.1	84	\|(% style="background-color:#e5e4e2; border-color:black" %)ID\|(% style="background-color:#e5e4e2; border-color:black" %)Марка
1.1	85	\|diesel\|дизель
	86	\|diesel_premium\|брендированный дизель
	87	\|a80\|бензин марки А80
	88	\|a92\|бензин марки А92
	89	\|a92_premium\|брендированный бензин марки А92
	90	\|a95\|бензин марки А95
	91	\|a95_premium\|брендированный бензин марки А95
	92	\|a98\|бензин марки А98
	93	\|a98_premium\|брендированный бензин марки А98
	94	\|a100\|бензин марки А100
	95	\|a100_premium\|брендированный бензин марки А100
	96	\|propane\|газ пропан
	97	\|metan\|метан
	98
33.1	99	== ==
	100
1.1	101	== Получение прайс-листа ==
	102
19.1	103	Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа HTTP запросом на baseUrl с префиксом /price?apikey={apikey} , запрос типа GET , timeout 10секунд.
1.1	104
11.1	105	В ответ Топаз "Web Офис" дает ответ в формате JSON{{{}}}
1.1	106
22.1	107	{{code language="javascript" layout="LINENUMBERS"}}
11.1	108	{
	109	{
	110	// идентификатор станции внутри Топаз "Web Офис"
	111	string StationId,
	112	// идентификатор топлива
	113	string ProductId,
	114	// цена за 1 литр
	115	double Price
	116	},
	117	…. N
	118	}
	119	{{/code}}
1.1	120
12.1	121	Пример ответа{{{}}}
1.1	122
12.1	123	{{code language="javascript"}}
	124	{
20.2	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},
12.1	128	}
	129	{{/code}}
1.1	130
33.1	131	== ==
	132
24.1	133	== Получение и обработка заказа ==
1.1	134
33.1	135	[[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2\|\|data-xwiki-image-style-border="true"]]
1.1	136
19.1	137	Информирование "Топаз-Web Office" о заказе и их статусах осуществляется HTTP запросом на baseUrl с префиксом /order , запрос типа POST , timeout 10 секунд.
1.1	138
22.1	139	Тело запроса содержит JSON вида Order{{{}}}
1.1	140
22.1	141	{{code language="javascript" layout="LINENUMBERS"}}
13.1	142	{
20.4	143	// Идентификатор заказа
	144	String Id
13.1	145	// дата и время создания в UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
20.4	146	String DateCreate
13.1	147	// идентификатор станции АЗС
20.4	148	String StationExtendedId
	149	// Тип заказа
	150	String OrderType
	151	// номер стороны (поста)
13.1	152	int ColumnId
20.4	153	// Идентификатор топлива
	154	String FuelId
	155	// Стоимость 1 литра топлива
13.1	156	double PriceFuel
20.4	157	// Сумма заказа
13.1	158	double Sum
20.4	159	// Размер заказа в литрах
13.1	160	double Litre
20.4	161	// Итого оплачено
13.1	162	double SumPaid
20.4	163	// Статус заказа
13.1	164	OrderStatus Status
	165	// дата и время завершения заказа UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
	166	String DateEnd
20.4	167	// Идентификатор причины отмены заказа
	168	String ReasonId
	169	// Причина отмены
	170	String Reason
	171	// Итого заправлено
13.1	172	double LitreCompleted
20.4	173	// Итого оплачено по завершению заказа
13.1	174	double SumPaidCompleted
20.4	175	// Идентификатор договора
	176	String ContractId
	177	// Способ оплаты
	178	String PayType
13.1	179	}
	180	{{/code}}
1.1	181
22.1	182	Обязательными полями при создании нового заказа являются:
	183
	184	{{code layout="LINENUMBERS" language="javascript"}}
	185	{
	186	"Id": "string",
	187	"DateCreate": "string",
	188	"OrderType": "Money",
	189	"StationExtendedId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
	190	"ColumnId": 0,
	191	"FuelId": "diesel"
	192	"PriceFuel": 0,
	193	"Sum": 0,
	194	"Litre": 0,
	195	"Status": "OrderCreated"
	196	"ContractId": "string"
	197	}
	198	{{/code}}
	199
1.1	200	Параметр OrderType – тип заказа может принимать следующие значения:
	201
20.3	202	* Money – заправка на фиксированную сумму
	203	* Liters – заправка на литры
1.1	204
	205	Параметр Status – статус заказа может принимать следующие значения
	206
	207	* OrderCreated – заказ создан и полностью оплачен
20.3	208	* Accepted - АЗС готова начать налив
	209	* Expired – статус от АЗС не поступил в течение 30 минут
1.1	210	* Completed – заказа завершен успешно
	211	* StationCanceled – заказ отменен оператором АЗС или же Топаз "Web Офис"
	212	* UserCanceled – заказ отменен пользователем
	213
	214	Параметр ContractId – стандартными типами договора, по которому обрабатывается заказ
	215
	216	* Individual – договор возмездного оказания услуг (физические лица)
	217	* Corporation - договор купли продажи топлива (юридические лица)
	218
	219	Так же можно указать любые другие типы договора по договоренности между сетью АЗС и внешней системой.
	220
	221	При получении заказа в статусе OrderCreated Топаз "Web Офис" проверяет ряд параметров StationExtendedId – в случае если идентификатор станции не найден в Топаз "Web Офис", то Топаз "Web Офис" дает ответ 400
	222
24.1	223	FuelId + PriceFuel – в случае если стоимость топлива в Топаз "Web Офис" отличается от присланной, то Топаз "Web Офис" дает ответ 402.
1.1	224
	225
24.1	226	== Проверка статуса работы станции ==
	227
	228	Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ baseUrl с префиксом
	229
	230	/ping?apikey={apikey}&stationId={stationId}&columnId={columnId},
	231
	232	stationId – идентификатор станции
	233
	234	columnId – идентификатор стороны ТРК
	235
	236	запрос типа GET , timeout 10 секунд.
	237
	238	==== Статусы ответов ====
	239
	240	200 ОК – станция и ТРК готова принять и обработать заказ
	241
35.1	242	400 – станция или ТРК не найдена (неверный идентификатор станции или ТРК)
24.1	243
35.1	244	404 – ТРК занята / ТРК не готова принять заказ
	245
24.1	246	любой ответ не 200 ОК – интерпретируется как на станции нет интернета / станция не доступна
	247
	248	----
	249
	250	Для получения статусов Интегратору необходимо со своей стороны реализовать сервис для их получения и обработки.
	251
26.1	252	== Методы REST API интегратора (внешней системы): ==
24.1	253
	254	1. Статус Accepted
	255	1. Статус Fueling
	256	1. Статус Canceled
	257	1. Статус Completed
	258	1. Отправка счетчика налива
	259
	260	Данные запросы "Топаз-Web Office" отправляет Интегратору.
	261
	262	=== Статус Accepted ===
	263
19.1	264	Данный статус сообщает внешней системе о том, что заказ принят и обработан в "Топаз-Web Office"
1.1	265
19.1	266	Данный статус "Топаз-Web Office" отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
1.1	267
19.1	268	В случае если внешняя система дала ответ, отличный от 200 ОК , то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
1.1	269
23.1	270	baseUrl + /api/order/accept
1.1	271
23.1	272	POST
	273
1.1	274	apikey={apikey}&orderId={ordeId}
	275
	276	все параметры являются обязательными
	277
33.1	278	=== ===
	279
24.1	280	=== Статус Fueling ===
1.1	281
19.1	282	Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
1.1	283
19.1	284	Данный статус "Топаз-Web Office" отсылает перед началом пуска колонки
1.1	285
19.1	286	В случае если внешняя система дала ответ, отличный от 200 ОК , то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
1.1	287
23.1	288	baseUrl + /api/order/fueling
1.1	289
23.1	290	POST
	291
1.1	292	apikey={apikey}&orderId={ordeId}
	293
	294	все параметры являются обязательными
	295
33.1	296	=== ===
	297
24.1	298	=== Статус Canceled ===
1.1	299
	300	Данный статус сообщает внешней системе о том, что заказ следует отменить
	301
17.1	302	baseUrl + /api/order/canceled
1.1	303
	304	POST
	305
	306	apikey={apikey}&orderId={ordeId}&reason={reason}
	307
	308	все параметры являются обязательными
	309
	310	reason – текстовая причина отмены
	311
33.1	312	=== ===
	313
24.1	314	=== Статус Completed ===
1.1	315
	316	Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
	317
19.1	318	В случае если внешняя система дала ответ отличный от 200 ОК , то "Топаз-Web Office" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа 200 ОК
1.1	319
17.1	320	baseUrl + /api/order/completed POST
1.1	321
23.1	322	apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&extendedDate={extendedDate}
1.1	323
	324	все параметры являются обязательными
	325
	326	litre – кол-во пролитых литров, указывается как double с разделителем точка extendedOrderId – идентификатор заказа в АСУ сети
	327
	328	extendedDate – дата по которой АСУ строит отчет для сверки, формат dd.MM.yyyy HH:mm:ss
	329
33.1	330	=== ===
	331
24.1	332	=== Отправка счетчика налива ===
1.1	333
19.1	334	В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива
1.1	335
19.1	336	Для этого с периодичностью от 5 – 10 секунд "Топаз-Web Office" выполняет следующий запрос
1.1	337
17.1	338	baseUrl + /api/order/volume
1.1	339
	340	POST
	341
	342	apikey={apikey}&orderId={ordeId}&litre={litre}
	343
	344	все параметры являются обязательными
	345
	346	litre – кол-во пролитых на момент отправки запроса литров, указывается как double с разделителем точка