Установка и конфигурирование

Описание процедуры внедрения и инициализации модуля Кошелёк TOTP в инфраструктуре ритейлера

Документация перемещена

Информация на этой странице не обновляется и может быть устаревшей. Наиболее полная и актуальная версия документации для разработчиков доступна по новому адресу:

https://developers.koshelek.app

Проверка одноразового пароля, сформированного Кошельком при предъявлении карты, а также проверка данных, передаваемых на сервер Кошелька для идентификации возможности оплаты через Кошелёк Pay, выполняется компонентом Passcode Verify — библиотекой Кошелька, поставляемой Кошельком проектной команде партнёра в формате AAR, JAR, DLL или SO — в зависимости от используемой партнером платформы кассового ПО. Библиотеку необходимо установить в среде кассового ПО.

Установка модуля Кошелёк TOTP

1. Запросите у представителя Кошелька компонент модуля Кошелёк TOTP (библиотека Passcode Verify). Библиотека поставляется в формате AAR, JAR, DLL или SO — в зависимости от используемой вами платформы.

2. Ознакомьтесь со сценариями использования модуля Кошелёк TOTP (см. Использование).

3. Выполните доработку ПО кассового сервера и кассовых сценариев в соответствии со сценариями использования модуля.

4. После первичной отладки доработанного ПО согласуйте с представителем Кошелька параметры инициализации модуля (см. Конфигурирование), которые будут передаваться методу init библиотеки Passcode Verify.

5. Выполните тестирование ПО кассового сервера и проверку работы всех методов библиотеки.

6. Реализуйте на кассе обработку ответов метода верификации ШК карты (метод barcodeVerify библиотеки Passcode Verify) в соответствии с представленными в документации сценариями.

7. Интегрируйте модуль Кошелёк TOTP с реализованным на кассе модулем интеграции, чтобы методы POST /availability-info, /checkout, /refund отправлялись с токеном, который был получен в результате вызова метода getToken библиотеки Passcode Verify.

8. Сообщите представителю Кошелька о том, что разработка всех процессов завершена. Это необходимо для перехода к совместному интеграционному тестированию всех сценариев взаимодействия ритейлера и Кошелька для обеспечения оплаты транзакций с помощью Кошелёк Pay.

9. Проведите интеграционное тестирование сценариев использования модуля совместно со специалистами Кошелька.

10. После завершения тестирования функциональность переносится в промышленную эксплуатацию.

11. Проинформируйте всех заинтересованных участников процессов о новых сценариях на кассе при предъявлении карт лояльности из Кошелька.

Конфигурирование

Установите конфигурационные параметры вашего модуля, которые будут использоваться для его инициализации.

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

Параметр	Тип	Описание
algorythm	String	Используемый алгоритм шифрования. Возможные значения: HMACSHA256 HMACSHA1
passLength	Int	Число символов одноразового пароля. Максимальное значение: 10
prefix	String	Префикс штрихкода. Значение по умолчанию: CM
key	String	Секретный ключ (шестнадцатеричная строка), необходимый для формирования парольной части TOTP.
interval	Int	Временной интервал (в секундах), в пределах которого одноразовый пароль считается действительным.
cardSessionLength	Int	Количество символов параметра cardSession.
delimeter	String	Разделитель между составляющими штрихкода (TOTP и основной частью). Не должен быть пустым.

Пример вызова метода init библиотеки Passcode Verify с передачей ему параметров инициализации:

init("HMACSHA256", 3, "CM", "key", 300, 5, " ")