Протокол интеграции систем внешних наливов с Топаз "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 Офис". Данный ключ необходимо будет передавать во всех запросах от внешней системы в Топаз "Web Офис" в заголовке externalSystemApikey

18

19

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

20

21

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

22

23

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

**...**

{

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

30

string Id

31

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

32

bool Enable,

33

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

string Name,

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

string Address,

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

location Location

{

double Lat,

double Lon },

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

Dictionary Columns {

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

(int32) Key:

{

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

48

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

}

} ... N

}

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

|ID|Марка

|diesel|дизель

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

59

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

60

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

61

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

62

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

63

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

64

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

65

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

66

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

67

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

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

|metan|метан

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

72

73

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

74

75

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

{

{

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

81

string StationId,

82

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

string ProductId,

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

double Price

},

…. N

}

{

{

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

96

string StationId,

97

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

string ProductId,

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

double Price

}, …. N

}

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

{

{“StationId”: “0001”, “ProductId”: “a92”, “Price”: 38.66},

111

{“StationId”: “0001”, “ProductId”: “a95_premium”, “Price”: 45.21},

112

{“StationId”: “0002”, “ProductId”: “a92”, “Price”: 38.98},

}

== Обработка заказа ==

117

118

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

119

120

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

121

122

123

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

{

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

128

string Id

129

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

String DateCreate

// значение заказа

double OrderVolume

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

134

string StationExtendedId

135

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

136

int ColumnId

137

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

138

string FuelId

139

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

150

String DateEnd

151

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

string ReasonId

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

string Reason

// итого сумма литров залито

156

double LitreCompleted

157

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

158

double SumPaidCompleted

159

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

string ContractId

}

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

165

166

* **Money **– заправка на фиксированную сумму, **OrderVolume **– сумма рублей

167

* **Liters **– заправка на литры, **OrderVolume **– кол-вол литров

168

169

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

170

171

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

172

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

173

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

174

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

175

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

176

177

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

178

179

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

180

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

181

182

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

183

184

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

185

186

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

187

188

== Передача статусов о заказе ==

189

190

=== Статус Accept ===

191

192

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

193

194

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

195

196

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

197

198

**базовый url + /api/order/accept POST**

199

200

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

201

202

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

203

204

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

205

206

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

207

208

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

209

210

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

211

212

**базовый url + /api/order/fueling POST**

213

214

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

215

216

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

217

218

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

219

220

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

221

222

**базовый url + /api/order/canceled**

**POST**

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

227

228

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

229

230

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

231

232

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

233

234

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

235

236

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

237

238

**базовый url + /api/order/completed POST**

239

240

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

241

242

**extendedDate={extendedDate}**

243

244

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