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

Версия 33.1 от Ярослава Ерина на 2024/12/11 12:58

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	(((
	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
	83	\|ID\|Марка
	84	\|diesel\|дизель
	85	\|diesel_premium\|брендированный дизель
	86	\|a80\|бензин марки А80
	87	\|a92\|бензин марки А92
	88	\|a92_premium\|брендированный бензин марки А92
	89	\|a95\|бензин марки А95
	90	\|a95_premium\|брендированный бензин марки А95
	91	\|a98\|бензин марки А98
	92	\|a98_premium\|брендированный бензин марки А98
	93	\|a100\|бензин марки А100
	94	\|a100_premium\|брендированный бензин марки А100
	95	\|propane\|газ пропан
	96	\|metan\|метан
	97
33.1	98	== ==
	99
1.1	100	== Получение прайс-листа ==
	101
19.1	102	Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа HTTP запросом на baseUrl с префиксом /price?apikey={apikey} , запрос типа GET , timeout 10секунд.
1.1	103
11.1	104	В ответ Топаз "Web Офис" дает ответ в формате JSON{{{}}}
1.1	105
22.1	106	{{code language="javascript" layout="LINENUMBERS"}}
11.1	107	{
	108	{
	109	// идентификатор станции внутри Топаз "Web Офис"
	110	string StationId,
	111	// идентификатор топлива
	112	string ProductId,
	113	// цена за 1 литр
	114	double Price
	115	},
	116	…. N
	117	}
	118	{{/code}}
1.1	119
12.1	120	Пример ответа{{{}}}
1.1	121
12.1	122	{{code language="javascript"}}
	123	{
20.2	124	{"StationId": "0001", "ProductId": "a92", "Price": 38.66},
	125	{"StationId": "0001", "ProductId": "a95_premium", "Price": 45.21},
	126	{"StationId": "0002", "ProductId": "a92", "Price": 38.98},
12.1	127	}
	128	{{/code}}
1.1	129
33.1	130	== ==
	131
24.1	132	== Получение и обработка заказа ==
1.1	133
33.1	134	[[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	135
19.1	136	Информирование "Топаз-Web Office" о заказе и их статусах осуществляется HTTP запросом на baseUrl с префиксом /order , запрос типа POST , timeout 10 секунд.
1.1	137
22.1	138	Тело запроса содержит JSON вида Order{{{}}}
1.1	139
22.1	140	{{code language="javascript" layout="LINENUMBERS"}}
13.1	141	{
20.4	142	// Идентификатор заказа
	143	String Id
13.1	144	// дата и время создания в UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
20.4	145	String DateCreate
13.1	146	// идентификатор станции АЗС
20.4	147	String StationExtendedId
	148	// Тип заказа
	149	String OrderType
	150	// номер стороны (поста)
13.1	151	int ColumnId
20.4	152	// Идентификатор топлива
	153	String FuelId
	154	// Стоимость 1 литра топлива
13.1	155	double PriceFuel
20.4	156	// Сумма заказа
13.1	157	double Sum
20.4	158	// Размер заказа в литрах
13.1	159	double Litre
20.4	160	// Итого оплачено
13.1	161	double SumPaid
20.4	162	// Статус заказа
13.1	163	OrderStatus Status
	164	// дата и время завершения заказа UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss
	165	String DateEnd
20.4	166	// Идентификатор причины отмены заказа
	167	String ReasonId
	168	// Причина отмены
	169	String Reason
	170	// Итого заправлено
13.1	171	double LitreCompleted
20.4	172	// Итого оплачено по завершению заказа
13.1	173	double SumPaidCompleted
20.4	174	// Идентификатор договора
	175	String ContractId
	176	// Способ оплаты
	177	String PayType
13.1	178	}
	179	{{/code}}
1.1	180
22.1	181	Обязательными полями при создании нового заказа являются:
	182
	183	{{code layout="LINENUMBERS" language="javascript"}}
	184	{
	185	"Id": "string",
	186	"DateCreate": "string",
	187	"OrderType": "Money",
	188	"StationExtendedId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
	189	"ColumnId": 0,
	190	"FuelId": "diesel"
	191	"PriceFuel": 0,
	192	"Sum": 0,
	193	"Litre": 0,
	194	"Status": "OrderCreated"
	195	"ContractId": "string"
	196	}
	197	{{/code}}
	198
1.1	199	Параметр OrderType – тип заказа может принимать следующие значения:
	200
20.3	201	* Money – заправка на фиксированную сумму
	202	* Liters – заправка на литры
1.1	203
	204	Параметр Status – статус заказа может принимать следующие значения
	205
	206	* OrderCreated – заказ создан и полностью оплачен
20.3	207	* Accepted - АЗС готова начать налив
	208	* Expired – статус от АЗС не поступил в течение 30 минут
1.1	209	* Completed – заказа завершен успешно
	210	* StationCanceled – заказ отменен оператором АЗС или же Топаз "Web Офис"
	211	* UserCanceled – заказ отменен пользователем
	212
	213	Параметр ContractId – стандартными типами договора, по которому обрабатывается заказ
	214
	215	* Individual – договор возмездного оказания услуг (физические лица)
	216	* Corporation - договор купли продажи топлива (юридические лица)
	217
	218	Так же можно указать любые другие типы договора по договоренности между сетью АЗС и внешней системой.
	219
	220	При получении заказа в статусе OrderCreated Топаз "Web Офис" проверяет ряд параметров StationExtendedId – в случае если идентификатор станции не найден в Топаз "Web Офис", то Топаз "Web Офис" дает ответ 400
	221
24.1	222	FuelId + PriceFuel – в случае если стоимость топлива в Топаз "Web Офис" отличается от присланной, то Топаз "Web Офис" дает ответ 402.
1.1	223
	224
24.1	225	== Проверка статуса работы станции ==
	226
	227	Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ baseUrl с префиксом
	228
	229	/ping?apikey={apikey}&stationId={stationId}&columnId={columnId},
	230
	231	stationId – идентификатор станции
	232
	233	columnId – идентификатор стороны ТРК
	234
	235	запрос типа GET , timeout 10 секунд.
	236
	237	==== Статусы ответов ====
	238
	239	200 ОК – станция и ТРК готова принять и обработать заказ
	240
	241	400 – станция или ТРК не найдена (не верный идентификатор станции или ТРК) 404 – ТРК занята / ТРК не готова принять заказ
	242
	243	любой ответ не 200 ОК – интерпретируется как на станции нет интернета / станция не доступна
	244
	245	----
	246
	247	Для получения статусов Интегратору необходимо со своей стороны реализовать сервис для их получения и обработки.
	248
26.1	249	== Методы REST API интегратора (внешней системы): ==
24.1	250
	251	1. Статус Accepted
	252	1. Статус Fueling
	253	1. Статус Canceled
	254	1. Статус Completed
	255	1. Отправка счетчика налива
	256
	257	Данные запросы "Топаз-Web Office" отправляет Интегратору.
	258
	259	=== Статус Accepted ===
	260
19.1	261	Данный статус сообщает внешней системе о том, что заказ принят и обработан в "Топаз-Web Office"
1.1	262
19.1	263	Данный статус "Топаз-Web Office" отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг
1.1	264
19.1	265	В случае если внешняя система дала ответ, отличный от 200 ОК , то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
1.1	266
23.1	267	baseUrl + /api/order/accept
1.1	268
23.1	269	POST
	270
1.1	271	apikey={apikey}&orderId={ordeId}
	272
	273	все параметры являются обязательными
	274
33.1	275	=== ===
	276
24.1	277	=== Статус Fueling ===
1.1	278
19.1	279	Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)
1.1	280
19.1	281	Данный статус "Топаз-Web Office" отсылает перед началом пуска колонки
1.1	282
19.1	283	В случае если внешняя система дала ответ, отличный от 200 ОК , то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ
1.1	284
23.1	285	baseUrl + /api/order/fueling
1.1	286
23.1	287	POST
	288
1.1	289	apikey={apikey}&orderId={ordeId}
	290
	291	все параметры являются обязательными
	292
33.1	293	=== ===
	294
24.1	295	=== Статус Canceled ===
1.1	296
	297	Данный статус сообщает внешней системе о том, что заказ следует отменить
	298
17.1	299	baseUrl + /api/order/canceled
1.1	300
	301	POST
	302
	303	apikey={apikey}&orderId={ordeId}&reason={reason}
	304
	305	все параметры являются обязательными
	306
	307	reason – текстовая причина отмены
	308
33.1	309	=== ===
	310
24.1	311	=== Статус Completed ===
1.1	312
	313	Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито
	314
19.1	315	В случае если внешняя система дала ответ отличный от 200 ОК , то "Топаз-Web Office" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа 200 ОК
1.1	316
17.1	317	baseUrl + /api/order/completed POST
1.1	318
23.1	319	apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&extendedDate={extendedDate}
1.1	320
	321	все параметры являются обязательными
	322
	323	litre – кол-во пролитых литров, указывается как double с разделителем точка extendedOrderId – идентификатор заказа в АСУ сети
	324
	325	extendedDate – дата по которой АСУ строит отчет для сверки, формат dd.MM.yyyy HH:mm:ss
	326
33.1	327	=== ===
	328
24.1	329	=== Отправка счетчика налива ===
1.1	330
19.1	331	В момент процесса налива "Топаз-Web Office" может сообщать внешней системе статус счетчика налива
1.1	332
19.1	333	Для этого с периодичностью от 5 – 10 секунд "Топаз-Web Office" выполняет следующий запрос
1.1	334
17.1	335	baseUrl + /api/order/volume
1.1	336
	337	POST
	338
	339	apikey={apikey}&orderId={ordeId}&litre={litre}
	340
	341	все параметры являются обязательными
	342
	343	litre – кол-во пролитых на момент отправки запроса литров, указывается как double с разделителем точка