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

1.1

1

====== **v 1.0.1** ======

2

3

== Настройка перед интеграцией ==

4

5

6

Перед началом интеграции, уполномоченный сотрудник компании, предоставляющей услуги внешних наливов, передает в ООО "Топаз-сервис" следующую информацию:

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**

**...**

{{{{

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

29

string Id

30

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

31

bool Enable,

32

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

string Name,

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

string Address,

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

location Location {

double Lat,

double Lon

},

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

42

Dictionary Columns

43

{

44

// номер колонки (int32)

45

Key: {

46

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

"Fuels": [

"a92",

"a95",

"diesel_premium",

...

N

]

}

}

...

N

}}}}

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

|ID|Марка

|diesel|дизель

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

65

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

66

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

67

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

68

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

69

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

70

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

71

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

72

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

73

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

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

|metan|метан

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

78

79

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

80

81

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

{{{{

{

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

86

string StationId,

87

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

string ProductId,

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

double Price

},

…. N

}}}}

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

{{{{

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

99

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

100

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

101

}}}}

102

103

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

104

105

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

106

107

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

108

109

110

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

111

112

{{{{

113

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

114

string Id

115

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

String DateCreate

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

double OrderVolume

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

120

string StationExtendedId

121

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

122

int ColumnId

123

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

124

string FuelId

125

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

136

String DateEnd

137

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

string ReasonId

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

string Reason

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

142

double LitreCompleted

143

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

144

double SumPaidCompleted

145

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

string ContractId

}}}}

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

150

151

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

152

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

153

154

155

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

156

157

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

158

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

159

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

160

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

161

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

162

163

164

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

165

166

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

167

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

168

169

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

170

171

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

172

173

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

174

175

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

176

177

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

178

179

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

180

181

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

182

183

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

184

185

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

186

187

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

188

189

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

190

191

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

192

193

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

194

195

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

196

197

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

198

199

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

200

201

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

202

203

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

204

205

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

206

207

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

208

209

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

**POST**

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

214

215

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

216

217

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

218

219

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

220

221

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

222

223

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

224

225

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

226

227

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

228

229

**extendedDate={extendedDate}**

230

231

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