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

Версия 38.1 от Ярослава Ерина на 2025/06/05 07:18

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