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

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

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