Протокол интеграции систем внешних наливов с Топаз "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

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

)))

== ApiKey ==

(% class="wikigeneratedid" %)

27

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

28

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

29

30

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

31

32

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

33

34

35

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

36

37

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

38

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

39

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

40

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

41

42

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

43

44

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

45

46

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

**...**

{

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

53

string Id

54

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

55

bool Enable,

56

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

string Name,

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

string Address,

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

location Location

{

double Lat,

double Lon },

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

Dictionary Columns {

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

(int32) Key:

{

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

71

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

}

} ... N

}

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

|ID|Марка

|diesel|дизель

|diesel_premium|брендированный дизель

82

|a80|бензин марки А80

83

|a92|бензин марки А92

84

|a92_premium|брендированный бензин марки А92

85

|a95|бензин марки А95

86

|a95_premium|брендированный бензин марки А95

87

|a98|бензин марки А98

88

|a98_premium|брендированный бензин марки А98

89

|a100|бензин марки А100

90

|a100_premium|брендированный бензин марки А100

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

|metan|метан

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

95

96

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

97

98

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

{

{

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

104

string StationId,

105

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

string ProductId,

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

double Price

},

…. N

}

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

{

{"StationId": "0001", "ProductId": "a92", "Price": 38.66},

120

{"StationId": "0001", "ProductId": "a95_premium", "Price": 45.21},

121

{"StationId": "0002", "ProductId": "a92", "Price": 38.98},

}

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

126

127

[[image:https://wiki.topazelectro.ru/download/attachments/1179735/image2023-1-19_16-21-33.png?version=1&modificationDate=1716374642000&api=v2]]

128

129

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

130

131

132

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

{

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

137

String Id

138

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

139

String DateCreate

140

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

141

String StationExtendedId

142

// Тип заказа

143

String OrderType

144

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

145

int ColumnId

146

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

147

String FuelId

148

// Стоимость 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

159

String DateEnd

160

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

String ReasonId

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

String Reason

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

double LitreCompleted

166

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

167

double SumPaidCompleted

168

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

String ContractId

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

String PayType

}

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

{

"Id": "string",

"DateCreate": "string",

181

"OrderType": "Money",

182

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

"ColumnId": 0,

"FuelId": "diesel"

"PriceFuel": 0,

"Sum": 0,

"Litre": 0,

"Status": "OrderCreated"

189

"ContractId": "string"

}

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

194

195

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

196

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

197

198

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

199

200

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

201

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

202

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

203

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

204

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

205

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

206

207

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

208

209

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

210

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

211

212

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

213

214

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

215

216

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

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

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 ОК **– интерпретируется как на станции нет интернета / станция не доступна

----

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

245

246

== **Методы REST API интегратора:** ==

247

248

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

249

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

250

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

251

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

252

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

253

254

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

255

256

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

257

258

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

259

260

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

261

262

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

263

264

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

**POST**

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

269

270

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

271

272

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

273

274

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

275

276

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

277

278

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

279

280

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

**POST**

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

285

286

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

287

288

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

289

290

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

291

292

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

**POST**

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

297

298

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

299

300

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

301

302

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

303

304

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

305

306

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

307

308

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

309

310

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

311

312

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

313

314

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