Облачная Касса: Интеграция с Фискальным Процессингом: различия между версиями
Merkulov (обсуждение | вклад) |
Merkulov (обсуждение | вклад) |
||
(не показано 6 промежуточных версий 2 участников) | |||
Строка 93: | Строка 93: | ||
{{ProductTable-2 | {{ProductTable-2 | ||
|title-left=''' | |title-left='''Payments''' - тип оплаты. | ||
|title-right= | |title-right= | ||
|content-left= | |content-left= | ||
Строка 135: | Строка 135: | ||
* '''RESORT_FEE''' | * '''RESORT_FEE''' | ||
* '''PLEDGE''' | * '''PLEDGE''' | ||
* '''CONSUMPTION''' | |||
* '''CONTRIBUTIONS_MPI_SE''' | |||
* '''CONTRIBUTIONS_MPI''' | |||
* '''CONTRIBUTIONS_CHI_SE''' | |||
* '''CONTRIBUTIONS_CHI''' | |||
* '''CONTRIBUTIONS_MSI''' | |||
* '''CASINO_PAYMENT''' | |||
* '''MONEY_PAYMENT''' | |||
* '''ATNM''' | |||
* '''ATM''' | |||
* '''TNM''' | |||
* '''TM''' | |||
|content-right= | |content-right= | ||
| | ||
Строка 156: | Строка 169: | ||
* Курортный сбор | * Курортный сбор | ||
* Залог | * Залог | ||
* Расход | |||
* Вкзносы на ОПС ИП | |||
* Взносы на ОПС | |||
* Взносы на ОМС ИП | |||
* Взносы на ОМС | |||
* Взносы на ОСС | |||
* Платеж казино | |||
* Выплата | |||
* Подакцизный маркируемый товар без КМ | |||
* Подакцизный маркируемый товар с КМ | |||
* Маркируемый товар без КМ | |||
* Марируемый товар с КМ | |||
|}}<br> | |}}<br> | ||
Строка 194: | Строка 219: | ||
|}}<br> | |}}<br> | ||
= Авторизация в OAuth2 при помощи токена коннектора = | |||
'''Токен коннектора''' - строка, содержащая символы и/или буквы и/или цифры. Это ссылка на одну или несколько облачных ККТ в сервисе '''БИФИТ Онлайн'''. Токен коннектора генерируется пользователем или партнером в ЛК '''БИФИТ Бизнес''' после оплаты аренды облачной ККТ. Таким образом, после авторизации по токену коннектора, все запросы обрабатываются на строго определенной/ых ККТ. | |||
{{ Note | '''''Примечание''''' | |||
* Все ссылки будут указаны для тестового контура ФП! '''https://fp-test.bifit.com/processing-api/.../''' | |||
* Для отладки интеграции в тестовом контуре, используйте токен коннектора: '''P5cKbUUD9uSSrSlGdzspLblvBnD0GzTAE0cLmAPSEMxJ79DtLE''' | |||
* Адрес "боевого" контура ФП '''https://fp.bifit.com/processing-api/.../'''|1000}} | |||
<br> | |||
{{ProductTable-2 | |||
|title-left='''Запрос''' | |||
|title-right='''POST''' | |||
|content-left= URL: https://fp-test.bifit.com/processing-api/oauth/token | |||
|content-right= | |||
<syntaxhighlight> | |||
https://fp-test.bifit.com/processing-api/oauth/token | |||
</syntaxhighlight> | |||
|}}<br> | |||
{{ProductTable-2 | |||
|title-left= Request Body | |||
|title-right= type: '''x-www-form-urlencoded''' | |||
|content-left= | |||
* '''token''': токен коннектора ФП. Необходимо получить в ЛК '''БИФИТ Онлайн''', либо у партнера БИФИТ КАССА. | |||
* '''client_id''': передать значение ''"processing-connector-token"'' | |||
* '''client_secret''': передать значение ''"processing-connector-token"'' | |||
* '''grant_type''': передать значение ''"token"'' | |||
|content-right= | |||
<syntaxhighlight lang="JSON"> | |||
token: "P5cKbUUD9uSSrSlGdzspLblvBnD0GzTAE0cLmAPSEMxJ79DtLE" | |||
client_id: "processing-connector-token" | |||
client_secret: "processing-connector-token" | |||
grant_type: "token" | |||
</syntaxhighlight> | |||
|}}<br> | |||
{{ProductTable-2 | |||
|title-left= Response | |||
|title-right= | |||
|content-left= | |||
* '''access_token''': токен доступа. Используется при отправке запросов ФП | |||
* '''token_type''': тип токена | |||
* '''refresh_token''': использовать для обновления токена доступа после истечении срока жизни (либо повторно авторизоваться с токеном коннектора) | |||
* '''expires_in''': срок жизни токена доступа в секундах. | |||
* '''scope''': | |||
* '''connector_id''': ID коннектора | |||
* '''jti''': | |||
|content-right= | |||
<syntaxhighlight lang="JSON"> | |||
{ | |||
access_token: "eyJhbGciOiJSUzI1NiI...YQqpk7w", | |||
token_type: "bearer", | |||
refresh_token: "eyJhbGciOiJSUzI1Ni.._782S_MQ", | |||
expires_in: 3599, | |||
scope: "read write", | |||
connector_id: 1, | |||
jti: "2f22e02e-4e72-4b68-991b-6aec065d996c" | |||
} | |||
</syntaxhighlight> | |||
|}}<br> | |||
= Авторизация в OAuth2 по refresh token = | |||
* По истечении времени жизни '''access_token''' (по умолчанию 1 час), Вы '''можете''' использовать механизм восстановления '''access_token''' по значению '''refresh_token''', полученному при помощи авторизации по токену коннектора. Однако, для восстановления '''access_token''', так же можно использовать повторную процедуру авторизации по токену коннектора. | |||
{{ Note | '''''Примечание''''' | |||
* Все ссылки будут указаны для тестового контура ФП! '''https://fp-test.bifit.com/processing-api/.../''' | |||
* Адрес "боевого" контура ФП '''https://fp.bifit.com/processing-api/.../'''|1000}} | |||
<br> | |||
{{ProductTable-2 | |||
|title-left='''Авторизация OAuth2''' | |||
|title-right='''POST''' | |||
|content-left= URL: https://fp-test.bifit.com/processing-api/oauth/token | |||
|content-right= | |||
<syntaxhighlight> | |||
https://fp-test.bifit.com/processing-api/oauth/token | |||
</syntaxhighlight> | |||
|}}<br> | |||
{{ProductTable-2 | |||
|title-left= Request Body | |||
|title-right= type: '''x-www-form-urlencoded''' | |||
|content-left= | |||
* '''refresh_token''': полученный при авторизации по токену коннектора | |||
* '''client_id''': передать значение ''":processing-connector-token"'' | |||
* '''client_secret''': передать значение ''":processing-connector-token"'' | |||
* '''grant_type''': передать значение ''"refresh_token"'' | |||
|content-right= | |||
<syntaxhighlight lang="JSON"> | |||
refresh_token: "eyJhbGciOiJSUzI1Ni.._782S_MQ" | |||
client_id: "processing-connector-token" | |||
client_secret: "processing-connector-token" | |||
grant_type: "refresh_token" | |||
</syntaxhighlight> | |||
|}}<br> | |||
{{ProductTable-2 | |||
|title-left= Response | |||
|title-right= | |||
|content-left= | |||
* '''access_token''': токен доступа. Используется при отправке запросов ФП | |||
* '''token_type''': тип токена | |||
* '''refresh_token''': использовать для обновления токена доступа после истечении срока жизни (либо повторно авторизоваться с токеном коннектора) | |||
* '''expires_in''': срок жизни токена доступа в секундах. | |||
* '''scope''': | |||
* '''connector_id''': ID коннектора | |||
* '''jti''': | |||
|content-right= | |||
<syntaxhighlight lang="JSON"> | |||
{ | |||
access_token: "ero3UNcffhlKdn5e76i...edfr_JU", | |||
token_type: "bearer", | |||
refresh_token: "tjlsoduopUIy76sdsf.._78tyfbv", | |||
expires_in: 3599, | |||
scope": "read write, | |||
connector_id: 1, | |||
jti: "2f22e02e-4e72-4b68-991b-6aec065d996c" | |||
} | |||
</syntaxhighlight> | |||
|}}<br> | |||
= Отправка документа на фискализацию в процессинг = | = Отправка документа на фискализацию в процессинг = | ||
Строка 565: | Строка 712: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
|}}<br> | |}}<br> | ||
= См. также = | |||
* [https://kassa.bifit.com/wiki/index.php?title=API:Отправка_чека_на_повторную_фискализацию Отправка чека на повторную фискализацию] | |||
* [https://kassa.bifit.com/wiki/index.php?title=БИФИТ_ОНЛАЙН:Авторизация_в_OAuth2_при_помощи_токена_коннектора Авторизация в OAuth2 при помощи токена коннектора] | |||
* [https://kassa.bifit.com/wiki/index.php?title=БИФИТ_ОНЛАЙН:Авторизация_в_OAuth2_по_refresh_token Авторизация в OAuth2 по refresh token] | |||
* [https://kassa.bifit.com/wiki/index.php?title=БИФИТ_ОНЛАЙН:Отправка_документа_на_фискализацию_в_процессинг Отправка документа на фискализацию в процессинг] | |||
* [https://kassa.bifit.com/wiki/index.php?title=БИФИТ_ОНЛАЙН:Отправка_документа_на_фискализацию_в_процессинг_(маркированный_товар) Отправка документа на фискализацию в процессинг (маркированный товар)] | |||
* [https://kassa.bifit.com/wiki/index.php?title=БИФИТ_ОНЛАЙН:Отправка_документа_на_фискализацию_в_процессинг_(агентский_товар) Отправка документа на фискализацию в процессинг (агентский товар)] | |||
* [https://kassa.bifit.com/wiki/index.php?title=БИФИТ_ОНЛАЙН:Запрос_информации_о_документе_по_ID Запрос информации о документе по ID] | |||
* [https://kassa.bifit.com/wiki/index.php?title=БИФИТ_ОНЛАЙН:Оффлайн_возможности_фискального_процессинга Оффлайн возможности фискального процессинга] | |||
* [https://kassa.bifit.com/wiki/index.php?title=БИФИТ_ОНЛАЙН:Справочник_Ошибок_(ФП) Справочник Ошибок (ФП)] |
Текущая версия на 15:15, 16 июня 2023
Введение
Данное руководство описывает процедуру интеграции ИС (Информационной Системы) заказчика с Фискальным Процессингом (далее ФП) БИФИТ Онлайн.
В документе описаны следующие процедуры:
- Авторизация в ФП - процесс необходимый для подключения клиента к фискальному процессингу,
- Формирование контент чека - формирование информации для дальнейшей отправки на фискализацию,
- Отправка чека в ФП - передача контента чека в фискальный процессинг для дальнейшей фискализации,
- Получение документа по ID - получение документа с фискальными признаками по его номеру.
Нумераторы
ReceiptType - тип фискального документа (тэг 1054) | |
|
|
TaxSystem - cистема налогообложения (тэг 1055). Если при регистрации устройства в ФНС было выбрано более одного режима налогообложения, то в TaxSystem необходимо указать, к какой системе налогообложения относится данный чек. | |
|
|
CalculationMethod - признак способа расчета (тэг 1214). | |
|
|
vat - ставка НДС (тэг 1199). | |
|
|
Payments - тип оплаты. | |
|
|
PaymentSubject - признак предмета расчета (тэг 1212). | |
|
|
PaymentAddress - место расчётов (тэг 1187). | |
По умолчанию то, которое задано при регистрации. В этом поле можно указать адрес сайта, на котором сделан чек или место установки вендингового оборудования |
address - телефон или электронный адрес покупателя (тэг 1008). | |
Телефон передаётся в формате "7ХХХХХХХХХХ" |
items - массив товарных позиций (тэг 1059). | |
|
|
Авторизация в OAuth2 при помощи токена коннектора
Токен коннектора - строка, содержащая символы и/или буквы и/или цифры. Это ссылка на одну или несколько облачных ККТ в сервисе БИФИТ Онлайн. Токен коннектора генерируется пользователем или партнером в ЛК БИФИТ Бизнес после оплаты аренды облачной ККТ. Таким образом, после авторизации по токену коннектора, все запросы обрабатываются на строго определенной/ых ККТ.
- Все ссылки будут указаны для тестового контура ФП! https://fp-test.bifit.com/processing-api/.../
- Для отладки интеграции в тестовом контуре, используйте токен коннектора: P5cKbUUD9uSSrSlGdzspLblvBnD0GzTAE0cLmAPSEMxJ79DtLE
- Адрес "боевого" контура ФП https://fp.bifit.com/processing-api/.../
Запрос | POST |
URL: https://fp-test.bifit.com/processing-api/oauth/token | https://fp-test.bifit.com/processing-api/oauth/token |
Request Body | type: x-www-form-urlencoded |
|
token: "P5cKbUUD9uSSrSlGdzspLblvBnD0GzTAE0cLmAPSEMxJ79DtLE"
client_id: "processing-connector-token"
client_secret: "processing-connector-token"
grant_type: "token"
|
Response | |
|
{
access_token: "eyJhbGciOiJSUzI1NiI...YQqpk7w",
token_type: "bearer",
refresh_token: "eyJhbGciOiJSUzI1Ni.._782S_MQ",
expires_in: 3599,
scope: "read write",
connector_id: 1,
jti: "2f22e02e-4e72-4b68-991b-6aec065d996c"
}
|
Авторизация в OAuth2 по refresh token
- По истечении времени жизни access_token (по умолчанию 1 час), Вы можете использовать механизм восстановления access_token по значению refresh_token, полученному при помощи авторизации по токену коннектора. Однако, для восстановления access_token, так же можно использовать повторную процедуру авторизации по токену коннектора.
- Все ссылки будут указаны для тестового контура ФП! https://fp-test.bifit.com/processing-api/.../
- Адрес "боевого" контура ФП https://fp.bifit.com/processing-api/.../
Авторизация OAuth2 | POST |
URL: https://fp-test.bifit.com/processing-api/oauth/token | https://fp-test.bifit.com/processing-api/oauth/token |
Request Body | type: x-www-form-urlencoded |
|
refresh_token: "eyJhbGciOiJSUzI1Ni.._782S_MQ"
client_id: "processing-connector-token"
client_secret: "processing-connector-token"
grant_type: "refresh_token"
|
Response | |
|
{
access_token: "ero3UNcffhlKdn5e76i...edfr_JU",
token_type: "bearer",
refresh_token: "tjlsoduopUIy76sdsf.._78tyfbv",
expires_in: 3599,
scope": "read write,
connector_id: 1,
jti: "2f22e02e-4e72-4b68-991b-6aec065d996c"
}
|
Отправка документа на фискализацию в процессинг
Запрос регистрации чека | POST |
https://fp-test.bifit.com/processing-api/protected/documents/registration/receipts | https://fp-test.bifit.com/processing-api/protected/documents/registration/receipts |
Request Headers | |
|
authorization: "Bearer ero3UNcffhlKdn5e76i...edfr_JU"
idempotency-key: "sdftfc-KF784mkd-skdhkaasca_lf34hKxsf"
|
Request Body | JSON структура |
|
{
"type": "SALE",
"taxSystem": "COMMON",
"cashier": {
"name": "Иванов И.И."
},
"client": {
"address": "test@test.com"
},
"items": [
{
"calculationMethod": "FULL_PAY",
"paymentSubject": "SERVICE",
"name": "Услуга",
"price": 100.00,
"quantity": 1.500,
"vat": "VAT_20",
"total": 150.00
}
],
"total": 150.00,
"payments": {
"CASH": 150.00
}
}
|
Response | |
|
254934 |
Запрос информации о документе по ID
Запрос информации о чеке по ID | GET |
https://fp-test.bifit.com/processing-api/protected/documents/{id} Используйте ID документа, полученного на предыдущем шаге, для получения информации о фискализации и контента чека. |
https://fp-test.bifit.com/processing-api/protected/documents/254934 |
Request Headers | |
|
authorization: "Bearer ero3UNcffhlKdn5e76i...edfr_JU"
|
Response | ||
Ответ содержит информацию о состоянии отправленного на фискализацию документа. В случае успешной фискализации, будет содержать следующую:
|
{
"id": 254934,
"executorType": "CONNECTOR",
"executorId": 1,
"kkmId": 50,
"kkm": {
"id": 50,
"vendor": "БИФИТ",
"model": "БФР-112ФС",
"factoryNumber": "98065732341002",
"inn": "7724923302",
"registrationNumber": "0000000001053073",
"fdNumber": "9999078902002260",
"fdStatus": null,
"taxSystems": [
"COMMON",
"SIMPLIFIED",
"SIMPLIFIED_WITH_EXPENSE",
"ENVD",
"COMMON_AGRICULTURAL"
],
"lastDocumentDate": 1614173792888,
"brokerVersion": "3.36"
},
"idempotencyKey": "b28463ba-48b6-4d95-8612-d2027d804f42",
"type": "RECEIPT",
"request": {
"type": "SALE",
"taxSystem": "COMMON",
"cashier": {
"name": "Иванов И.И."
},
"client": {
"address": "test@test.com"
},
"items": [
{
"calculationMethod": "FULL_PAY",
"paymentSubject": "SERVICE",
"name": "Услуга",
"price": 100.00,
"quantity": 1.500,
"vat": "VAT_20",
"total": 150.00
}
],
"total": 150.00,
"payments": {
"CASH": 150.00
}
},
"response": {
"raw": "--------------------------------\n Кассовый чек \n ПРИХОД \n АО БИФИТ \nг.Москва, Ниж. Первомайская, д.4\n 6 \n 15:04:22 12:17 \n--------------------------------\nУслуга \n1.5 * 100.00 = 150.00\nНДС 20% \nУСЛУГА \n--------------------------------\nИТОГ = 150.00\nНАЛИЧНЫМИ = 150.00\nСУММА НДС 20% = 25.00\nЭЛ.АДР.ПОКУПАТЕЛЯ test@test.com\nЭЛ.АДР.ОТПРАВИТЕЛЯ \n noname@email.com\nКАССИР Иванов И.И.\nЧЕК 39\nСМЕНА 299\nСНО ОСН\nИНН 7724923302\nРН ККТ 0000000001053073\nФН 9999078902002260\nФД 5088\nФП 3705633526\n",
"shiftNumber": 299,
"receiptNumber": 39
},
"fiscalDocument": 5088,
"fiscalAmount": 150.00,
"fiscalTime": 1650014239472,
"fiscalSign": "3705633526",
"fiscalDrive": "9999078902002260",
"status": "SUCCESS",
"created": 1650014238962,
"changed": 1650014240672
}
|
Оффлайн возможности фискального процессинга
Фискальный процессинг позволяет сформировать HTML страницу с информацией о чеке, для предоставления клиенту, в "оффлайн режиме". Такая возможность обеспечивается за счет использования специального GET запроса без авторизации с использованием ключа идемпотентности. В случае, если документ не может быть передан в процессинг по причине отсутствия связи между клиентом и сервером, сервер вернет информацию о необходимости подождать завершения процесса обработки фискального документа. Такой запрос можно представить в виде QR кода, для считывания камерой смартфона.
Запрос информации о чеке по Ключу идемпотентности | GET |
https://fp-test.bifit.com/processing-api/receipts/{idempotency_key} Используйте ID документа, полученного на предыдущем шаге, для получения информации о фискализации и контента чека. |
https://fp-test.bifit.com/processing-api/receipts/b28463ba-48b6-4d95-8612-d2027d804f42 |
Справочник Ошибок
Структура ошибок в формировании запросов или авторизации | Структура ошибок в бизнес логике (некорректные документы, отсутствие прав и т.д) |
{
"error": String,
"error_description": String
}
|
{
"type": String,
"message": String,
"dependentErrors": Object
}
|
Перечень статусов документов | |
|
Перечень ошибок | |
Если запрошенный по ID документ находится в статусе FAIL, это означает, что ККТ по каким-то причинам не фискализировала такую транзакцию. Перечень причин см. в правой части |
ERR20002:
statusCode: 503
code: ERR20002
description: Запрос не может быть выполнен. Попробуйте позже
ERR20005:
statusCode: 400
code: ERR20005
description: Некорректный запрос
ERR20008:
statusCode: 401
code: ERR20008
description: Некорректный пароль
ERR20012:
statusCode: 401
code: ERR20012
description: Доступ запрещен
ERR20013:
statusCode: 400
code: ERR20013
description: Ошибка ФН
ERR20014:
statusCode: 400
code: ERR20014
description: Некорректный запрос
ERR20015:
statusCode: 404
code: ERR20015
description: Неизвестный ФН
ERR20016:
statusCode: 400
code: ERR20016
description: Некорректный запрос
ERR20017:
statusCode: 400
code: ERR20017
description: Смена не открыта
ERR20018:
statusCode: 400
code: ERR20018
description: Смена превысила 24 часа
ERR20019:
statusCode: 400
code: ERR20019
description: Хост недоступен
|
См. также
- Отправка чека на повторную фискализацию
- Авторизация в OAuth2 при помощи токена коннектора
- Авторизация в OAuth2 по refresh token
- Отправка документа на фискализацию в процессинг
- Отправка документа на фискализацию в процессинг (маркированный товар)
- Отправка документа на фискализацию в процессинг (агентский товар)
- Запрос информации о документе по ID
- Оффлайн возможности фискального процессинга
- Справочник Ошибок (ФП)