Изменения документа Протокол интеграции систем внешних наливов с Топаз "Web Офис"
Редактировал(а) Dmitriy 2026/04/23 06:18
От версии 19.1
отредактировано Ярослава Ерина
на 2024/11/28 10:45
на 2024/11/28 10:45
Изменить комментарий:
К данной версии нет комментариев
Сводка
-
Свойства страницы (2 изменено, 0 добавлено, 0 удалено)
Подробности
- Свойства страницы
-
- Автор документа
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki.erin a_jv1 +XWiki.erin_ds - Содержимое
-
... ... @@ -21,7 +21,7 @@ 21 21 === **Данный ключ необходимо будет передавать во всех запросах от внешней системы в "Топаз-Web Office" в заголовке (header) externalSystemApikey** === 22 22 ))) 23 23 24 -== =ApiKey ===24 +== ApiKey == 25 25 26 26 (% class="wikigeneratedid" %) 27 27 Интегратору необходимо для каждого своего клиента (сети АЗС) сформировать и хранить в собственной базе данных уникальный Apikey. ... ... @@ -39,7 +39,7 @@ 39 39 40 40 **...** 41 41 42 -{{code language="javascript"}} 42 +{{code language="javascript" layout="LINENUMBERS"}} 43 43 { 44 44 // идентификатор станции АЗС 45 45 string Id ... ... @@ -89,7 +89,7 @@ 89 89 90 90 В ответ Топаз "Web Офис" дает ответ в формате **JSON**{{{}}} 91 91 92 -{{code language="javascript"}} 92 +{{code language="javascript" layout="LINENUMBERS"}} 93 93 { 94 94 { 95 95 // идентификатор станции внутри Топаз "Web Офис" ... ... @@ -109,9 +109,9 @@ 109 109 110 110 {{code language="javascript"}} 111 111 { 112 -{ “StationId”:“0001”,“ProductId”:“a92”,“Price”: 38.66},113 -{ “StationId”:“0001”,“ProductId”:“a95_premium”,“Price”: 45.21},114 -{ “StationId”:“0002”,“ProductId”:“a92”,“Price”: 38.98},112 +{"StationId": "0001", "ProductId": "a92", "Price": 38.66}, 113 +{"StationId": "0001", "ProductId": "a95_premium", "Price": 45.21}, 114 +{"StationId": "0002", "ProductId": "a92", "Price": 38.98}, 115 115 } 116 116 {{/code}} 117 117 ... ... @@ -122,56 +122,77 @@ 122 122 Информирование "Топаз-Web Office" о заказе и их статусах осуществляется **HTTP **запросом на **baseUrl **с префиксом **/order **, запрос типа **POST **, timeout 10 секунд. 123 123 124 124 125 -**Тело запроса содержит JSON вида Order **{{{}}}125 +**Тело запроса содержит JSON вида Order{{{}}}** 126 126 127 -{{code language=" none"}}127 +{{code language="javascript" layout="LINENUMBERS"}} 128 128 { 129 -// идентификатор заказа130 - string Id129 +// Идентификатор заказа 130 +String Id 131 131 // дата и время создания в UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss 132 -String DateCreate 133 -// значение заказа 134 -double OrderVolume 132 +String DateCreate 135 135 // идентификатор станции АЗС 136 -string StationExtendedId 137 -// номер колонки 134 +String StationExtendedId 135 +// Тип заказа 136 +String OrderType 137 +// номер стороны (поста) 138 138 int ColumnId 139 -// идентификатор топлива140 - string FuelId141 -// стоимость 1 литра топлива139 +// Идентификатор топлива 140 +String FuelId 141 +// Стоимость 1 литра топлива 142 142 double PriceFuel 143 -// сумма заказа143 +// Сумма заказа 144 144 double Sum 145 -// к ол-волитров145 +// Размер заказа в литрах 146 146 double Litre 147 -// итого оплачено147 +// Итого оплачено 148 148 double SumPaid 149 -// статус заказа149 +// Статус заказа 150 150 OrderStatus Status 151 151 // дата и время завершения заказа UTC, формат даты yyyy-MM-dd'T'HH:mm:ss.SSSSSSS'Z' либо yyyy-MM-dd HH:mm:ss 152 152 String DateEnd 153 -// идентификатор причины отмены заказа154 - string ReasonId155 -// причина отмены156 - string Reason157 -// итогосуммалитров залито153 +// Идентификатор причины отмены заказа 154 +String ReasonId 155 +// Причина отмены 156 +String Reason 157 +// Итого заправлено 158 158 double LitreCompleted 159 -// итого оплачено по завершению заказа159 +// Итого оплачено по завершению заказа 160 160 double SumPaidCompleted 161 -// идентификатор договора 162 -string ContractId 161 +// Идентификатор договора 162 +String ContractId 163 +// Способ оплаты 164 +String PayType 163 163 } 164 164 {{/code}} 165 165 168 +**Обязательными полями при создании нового заказа являются:** 169 + 170 +{{code layout="LINENUMBERS" language="javascript"}} 171 +{ 172 + "Id": "string", 173 + "DateCreate": "string", 174 + "OrderType": "Money", 175 + "StationExtendedId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 176 + "ColumnId": 0, 177 + "FuelId": "diesel" 178 + "PriceFuel": 0, 179 + "Sum": 0, 180 + "Litre": 0, 181 + "Status": "OrderCreated" 182 + "ContractId": "string" 183 +} 184 +{{/code}} 185 + 166 166 Параметр **OrderType **– тип заказа может принимать следующие значения: 167 167 168 -* **Money **– заправка на фиксированную сумму , **OrderVolume **– сумма рублей169 -* **Liters **– заправка на литры , **OrderVolume **– кол-вол литров188 +* **Money **– заправка на фиксированную сумму 189 +* **Liters **– заправка на литры 170 170 171 171 Параметр **Status **– статус заказа может принимать следующие значения 172 172 173 173 * **OrderCreated **– заказ создан и полностью оплачен 174 -* **Expire **– статус от АЗС не поступил в течение 30 минут 194 +* **Accepted **- АЗС готова начать налив 195 +* **Expired **– статус от АЗС не поступил в течение 30 минут 175 175 * **Completed **– заказа завершен успешно 176 176 * **StationCanceled **– заказ отменен оператором АЗС или же Топаз "Web Офис" 177 177 * **UserCanceled **– заказ отменен пользователем ... ... @@ -189,7 +189,7 @@ 189 189 190 190 == Передача статусов о заказе == 191 191 192 -=== Статус Accept === 213 +=== Статус Accepted === 193 193 194 194 Данный статус сообщает внешней системе о том, что заказ принят и обработан в "Топаз-Web Office" 195 195