Интеграция с Мобильным кассиром SDK 1.0.1

Для интеграции с “Мобильным кассиром” используйте RemoteCashierSDK. Он позволяет производить оплату и возврат разными способами с помощью App-To-App взаимодействия стороннего приложения с приложением “Мобильный кассир”. Пример интеграции вы можете посмотреть по этой ссылке.

RemoteCashierSDK позволяет:

• указать необходимость печати бумажного чека на кассе, а также его отправки. Эти параметры можно передать из стороннего приложения;
• выбрать способ оплаты и возврата:
  • Наличные — оплата и возврат;
  • Безналичные, в том числе “Плати QR от Сбера” и “Tap On Phone от Сбера” — оплата и возврат;
  • Комбинированная оплата — только оплата;
  • Аванс — только оплата;
• ознакомиться с предварительным чеком;
• отправить чек на кассу для фискализации. Возможно только при использовании терминала или облачной кассы;
• отправить чек на указанные реквизиты;
• получить ответ об успешности операции при возвращении в стороннее приложение;
• проверить подключение кассы в “Мобильном кассире”. Если касса не подключена, то пользователь увидит экран с ошибкой и предложением вернуться в стороннее приложение.

Требования для работы с RemoteCashierSDK

RemoteCashierSDK — универсальная библиотека для Android. Для ее корректной работы в приложении “Мобильный кассир” нужно:

• зарегистрироваться в личном кабинете Эвотор на сайте market.evotor.ru;
• подключить кассу;
• выбрать необходимые способы оплаты для совершения операций. Для этого в “Мобильном кассире” перейдите в Настройки → Способы оплаты.

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

Для интеграции с Мобильным кассиром нужно добавить в проект зависимость от библиотеки Эвотора и импортировать интерфейс.

Шаг 1. Добавьте зависимость

Добавьте в проект зависимости от библиотеки RemoteCashierSDK. Для этого:

1. в build.gradle app добавьте:

    dependencies {
      …
      implementation 'com.github.Evotor—InnTech:RemoteCashierSDK:1.0.1'
    }
   

2. в build.gradle Project добавьте:

buildscript {
  …
  repositories {
    …
    maven { url "https://jitpack.io" }
  }
}

Шаг 2. Создайте объект Integration

1. Импортируйте в проект интерфейс и реализующий его класс:
   • ru.evotor.integration.Integration — интерфейс;
   • ru.evotor.integration.IntegrationImpl — реализующий класс.
2. Создайте объект Integration:

   private val integration: integration by lazy { IntegrationImpl() }
   

Описание доступных функций

Выполнение платежа

fun startPayment(receipt: Receipt_V1)

На телефоне должно быть установлено приложение «Мобильный кассир». При вызове открывается activity приложения. Параметр функции: чек с типом Receipt_V1, где V1 — текущая версия классов данных библиотеки.

Описание полей класса Receipt_V1:

• uuid: String — uuid чека;
• positions: List<Position_V1> — список позиций чека. Класс Position_V1 содержит поля следующие поля:
  • price: BigDecimal — цена товара;
  • name: String — наименование товара;
  • measureName: String — единицы измерения товара: шт, кг, л, м, м2, м3,компл, упак, ед, дроб;
  • quantity: BigDecimal — количество товара;
  • tax: String — тип НДС. Возможные значения: null, NO_VAT, VAT_10, VAT_18, VAT_0, VAT_18_118, VAT_10_110;
  • commodityId: String — uuid товара. Может быть null;
  • priceWithDiscount: BigDecimal — цена со скидкой. Может быть null;
  • type: Type_V1 — тип товара. Может быть null. Доступные объекты класса Type_V1:
    • NORMAL — обычный;
    • ALCOHOL_MARKED — маркированный алкоголь;
    • ALCOHOL_NOT_MARKED — немаркированный алкоголь;
    • TOBACCO_MARKED — маркированный табак;
    • SHOES_MARKED — маркированная обувь;
    • MEDICINE_MARKED — маркированные лекарства;
    • SERVICE — услуга;
    • PERFUME_MARKED — маркированные духи;
    • LIGHT_INDUSTRY_MARKED — маркированные одежда и белье;
    • PHOTOS_MARKED — маркированная фотоаппаратура;
    • TYRES_MARKED — маркированные шины;
• clientEmail: String — email покупателя. Может быть null;
• clientPhone: String — номер телефона покупателя. Может быть null;
• shouldPrintReceipt: Boolean — напечатать чек. По умолчанию false;
• paymentPlace: String — место платежа. Может быть null;
• paymentAddress: String — адрес платежа. Может быть null;
• receiptDiscount: BigDecimal — скидка на чек. Может быть null;
• tapOnPhoneRefId: String — идентификатор транзакции Tap On Phone. Может быть null;
• creationDate: Date — дата создания чека. Может быть null;
• extra: String — дополнительная информация. Может быть null;
• operationType: OperationType_V1 — тип операции. Доступные объекты класса OperationType_V1:
  • SELL — продажа;
  • PAYBACK — возврат.

Обработка ответа на совершённую операцию

fun handlePaymentResult(registry: ActivityResultRegistry, transactionResultHandler (TransactionResult) -> Unit)

В функцию передайте параметр с типом ActivityResultRegistry. Лямбда-выражение возвращает ответ с типом TransactionResult.

Описание полей класса TransactionResult:

• receiptUuid: String — uuid чека;
• operationResult: OperationResult — результат операции. Класс OperationResult содержит следующие поля:
  • success: Boolean — успех операции;
  • message: String — сообщение операции.

Тестирование интеграции

Для проверки интеграции мы рекомендуем использовать в “Мобильном кассире” виртуальную кассу. Это позволит не использовать настоящие деньги при тестировании.