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

v 1.0.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

17

Также будет предоставлен секретный ключ (тестового и боевого окружения) для идентификации системы внешних наливов в "Топаз-Web Office".

18

19

(% class="box errormessage" %)

20

(((

21

(% class="wikigeneratedid" id="H41443043D43D44B43943A43B44E44743D43543E43144543E43443843C43E43144343443544243F43544043543443043243044244C43243E43244143544543743043F44043E44143044543E44243243D43544843D43543944143844144243543C44B4322242243E43F430437-WebOffice2243243743043343E43B43E43243A43528header29externalSystemApikey" %)

22

(((

23

=== **Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey** ===

)))

)))

== ApiKey ==

(% class="wikigeneratedid" %)

30

Интегратору необходимо для каждого своего клиента (сети АЗС) сформировать и хранить в собственной базе данных уникальный Apikey.

31

С помощью этого Apikey происходит идентификация клиента (сети АЗС) при обмене между "Топаз-Web Office" и системой Интегратора.

32

33

== Адрес для отправки запросов ==

34

35

Базовым адресом **(baseUrl)** для выполнения запросов является [[https:~~/~~/topazoffice.ru/ms/external-fueling/integration>>https://topazoffice.ru/ms/external-fueling/integration]]

----

== **Методы API "Топаз-Web Office":** ==

40

41

1. **Получение списка АЗС и их конфигураций**

42

1. **Получение прайс-листа**

43

1. **Получение и обработка заказа**

44

1. **Проверка статуса работы станции**

45

46

== Получение списка АЗС и их конфигураций ==

47

48

Внешняя система опрашивает "Топаз-Web Office" для получения списка АЗС и их конфигураций **через HTTP **запрос на **baseUrl **с префиксом **/station?apikey={apikey **}, запрос типа **GET **, timeout 10 секунд.

49

50

В ответ Топаз "Web Офис" дает ответ в формате **JSON**

**...**

{

// идентификатор станции АЗС

57

string id

58

// статус станции: true – доступна, false – выключена

59

bool enable,

60

// наименование станции

string name,

// адрес станции

string address,

// гео точка на карте

location location

{

double lat,

double lon },

// словарь доступных ТРК

Dictionary columns {

// номер колонки

(int32) Key:

{

// список доступных типов топлива

75

"fuels": [ "a92", "a95", "diesel_premium", ... N ]

}

} ... N

}

**Возможные идентификаторы топлива**

82

83

(% border="1" %)

84

|(% style="background-color:#e5e4e2; border-color:black" %)ID|(% style="background-color:#e5e4e2; border-color:black" %)Марка

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

|propane|газ пропан

|metan|метан

== ==

== Получение прайс-листа ==

102

103

Внешняя система опрашивает "Топаз-Web Office" для получения прайс-листа **HTTP **запросом на **baseUrl **с префиксом **/price?apikey={apikey} **, запрос типа **GET **, timeout 10секунд.

104

105

В ответ Топаз "Web Офис" дает ответ в формате **JSON**{{{}}}

{

{

// идентификатор станции внутри Топаз "Web Офис"

111

string stationId,

112

// идентификатор топлива

string productId,

// цена за 1 литр

double price

// Внешний код топлива

117

string fuelExtendedId

},

…. N

}

**Пример ответа**{{{}}}

{

{"stationId": "0001", "productId": "a92", "price": 38.66, "fuelExtendedId": "92"},

128

{"stationId": "0001", "productId": "a95_premium", "price": 45.21, "fuelExtendedId": "95"},

129

{"stationId": "0002", "productId": "a92", "price": 38.98, , "fuelExtendedId": "92"},

}

== ==

== Получение и обработка заказа ==

136

137

[[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"]]

138

139

Информирование "Топаз-Web Office" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд.

140

141

**Тело запроса содержит JSON вида Order{{{}}}**

{

// Идентификатор заказа

146

String Id

147

// дата и время создания в UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss

148

String DateCreate

149

// идентификатор станции АЗС

150

String StationExtendedId

151

// Тип заказа

152

String OrderType

153

// номер стороны (поста)

154

int ColumnId

155

// Идентификатор топлива

156

String FuelId

157

// Стоимость 1 литра топлива

double PriceFuel

// Сумма заказа

double Sum

// Размер заказа в литрах

double Litre

// Итого оплачено

double SumPaid

// Статус заказа

OrderStatus Status

// дата и время завершения заказа UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss

168

String DateEnd

169

// Идентификатор причины отмены заказа

String ReasonId

// Причина отмены

String Reason

// Итого заправлено

double LitreCompleted

175

// Итого оплачено по завершению заказа

176

double SumPaidCompleted

177

// Идентификатор договора

String ContractId

// Способ оплаты

String PayType

}

**Обязательными полями при создании нового заказа являются:**

{

"Id": "string",

"DateCreate": "string",

190

"OrderType": "Money",

191

"StationExtendedId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"ColumnId": 0,

"FuelId": "diesel"

"PriceFuel": 0,

"Sum": 0,

"Litre": 0,

"Status": "OrderCreated"

198

"ContractId": "string"

}

Параметр **OrderType **– тип заказа может принимать следующие значения:

203

204

* **Money **– заправка на фиксированную сумму

205

* **Liters **– заправка на литры

206

207

Параметр **Status **– статус заказа может принимать следующие значения

208

209

* **OrderCreated **– заказ создан и полностью оплачен

210

* **Accepted **- АЗС готова начать налив

211

* **Expired **– статус от АЗС не поступил в течение 30 минут

212

* **Completed **– заказа завершен успешно

213

* **StationCanceled **– заказ отменен оператором АЗС или же Топаз "Web Офис"

214

* **UserCanceled **– заказ отменен пользователем

215

216

Параметр **ContractId **– стандартными типами договора, по которому обрабатывается заказ

217

218

* **Individual **– договор возмездного оказания услуг (физические лица)

219

* **Corporation **- договор купли продажи топлива (юридические лица)

220

221

Так же можно указать любые другие типы договора по договоренности между сетью АЗС и внешней системой.

222

223

При получении заказа в статусе **OrderCreated **Топаз "Web Офис" проверяет ряд параметров **StationExtendedId **– в случае если идентификатор станции не найден в Топаз "Web Офис", то Топаз "Web Офис" дает ответ **400**

224

225

**FuelId **+ **PriceFuel **– в случае если стоимость топлива в Топаз "Web Офис" отличается от присланной, то Топаз "Web Офис" дает ответ **402.**

226

227

228

== Проверка статуса работы станции ==

229

230

Перед формирование заказ внешняя система делает запрос на станцию для определения доступности и готовности станции принять заказ **baseUrl **с префиксом

231

232

**/ping?apikey={apikey}&stationId={stationId}&columnId={columnId},**

233

234

**stationId **– идентификатор станции

235

236

**columnId **– идентификатор стороны ТРК

237

238

запрос типа **GET **, timeout 10 секунд.

239

240

==== **Статусы ответов** ====

241

242

**200 ОК **– станция и ТРК готова принять и обработать заказ

243

244

**400 **– станция или ТРК не найдена (неверный идентификатор станции или ТРК)

245

246

**404 **– ТРК занята / ТРК не готова принять заказ

247

248

любой ответ не **200 ОК **– интерпретируется как на станции нет интернета / станция не доступна

----

Для получения статусов Интегратору необходимо со своей стороны реализовать сервис для их получения и обработки.

253

254

== **Методы REST API интегратора (внешней системы):** ==

255

256

1. **Статус Accepted**

257

1. **Статус Fueling**

258

1. **Статус Canceled**

259

1. **Статус Completed**

260

1. **Отправка счетчика налива**

261

262

Данные запросы "Топаз-Web Office" отправляет Интегратору.

263

264

=== **Статус Accepted** ===

265

266

Данный статус сообщает внешней системе о том, что заказ принят и обработан в "Топаз-Web Office"

267

268

Данный статус "Топаз-Web Office" отсылает после того, как были произведены некоторые действия с заказом (например, заказ сохранен в базе данных) и система готова перейти на следующий шаг

269

270

В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ

271

272

**baseUrl + /api/order/accept**

**POST**

**apikey={apikey}&orderId={ordeId}**

277

278

все параметры являются обязательными

=== ===

=== **Статус Fueling** ===

283

284

Данный статус сообщает внешней системе о том, что "Топаз-Web Office" готов запустить колонку (начать пролив)

285

286

Данный статус "Топаз-Web Office" отсылает перед началом пуска колонки

287

288

В случае если внешняя система дала ответ, отличный от **200 ОК **, то "Топаз-Web Office" отсылает статус Canceled и прекращает обработку заказ

289

290

**baseUrl + /api/order/fueling**

**POST**

**apikey={apikey}&orderId={ordeId}**

295

296

все параметры являются обязательными

=== ===

=== **Статус Canceled** ===

301

302

Данный статус сообщает внешней системе о том, что заказ следует отменить

303

304

**baseUrl + /api/order/canceled**

**POST**

**apikey={apikey}&orderId={ordeId}&reason={reason}**

309

310

все параметры являются обязательными

311

312

**reason – **текстовая причина отмены

=== ===

=== **Статус Completed** ===

317

318

Данный статус сообщает внешней системе о том, что заказ выполнен и топливо залито

319

320

В случае если внешняя система дала ответ отличный от **200 ОК **, то "Топаз-Web Office" отсылает запросы с некоторым отложенным количеством времени до момента получения ответа **200 ОК**

321

322

**baseUrl + /api/order/completed POST**

323

324

**apikey={apikey}&orderId={ordeId}&litre={litre}&extendedOrderId={extendedOrderId}&extendedDate={extendedDate}**

325

326

все параметры являются обязательными

327

328

**litre **– кол-во пролитых литров, указывается как **double **с разделителем точка **extendedOrderId **– идентификатор заказа в АСУ сети