Setup and Configuration

Description of Koshelek TOTP integration procedure

Documentation has moved

The information on this page is no longer updated and may be obsolete. The most current Koshelek documentation is now available at the new address:

https://developers.koshelek.app/en/

Behind the name "Koshelek TOTP Module" is a software library Passcode Verify. It is this library that performs TOTP verification routine and Koshelek Pay availability check for mobile loyalty cards presented in customer's Koshelek app.

The Passcode Verify library must be deployed in your cash desk software environment.

Setup

1. Contact your Koshelek representative to get your Koshelek TOTP Module (Passcode Verify library). Depending on your environment, the library is available in the AAR, JAR, DLL, and SO formats.

2. Get acquainted with Koshelek TOTP Module Usage scenarios.

3. Upgrade your cash desk backend and enhance your cash desk scenarios so that they align with Koshelek TOTP Module usage scenarios.

4. After early upgrade debugging, contact your Koshelek representative to agree Koshelek TOTP Module initialization parameters to be used in your implementation project (refer to Configuration below). Configure the module with agreed parameters by making the init() call to your Passcode Verify library.

5. Conduct testing of your cash desk server software and verify all library calls for correct operation.

6. Upgrade your cash desk software to implement processing of barcode verification response from Passcode Verify library (method barcodeVerify()) in accordance with Usage scenarios.

7. Integrate your Koshelek TOTP Module with your Koshelek Pay API implementation, so that API requests POST /availability-info, /checkout, /refund will include the token value obtained by the getToken() call to Passcode Verify library.

8. Contact your Koshelek representative when you're done. At this point, we can proceed with integration testing of all Koshelek Pay Usage Scenarios.

9. Complete end-to-end testing of all Koshelek Pay scenarios in cooperation with the Koshelek team.

10. When testing is complete, you are ready to transit Koshelek Pay in production.

11. Notify all related participants of new payment method "Koshelek Pay" availability for loyalty cards presented from the Koshelek app.

Configuration

To configure your Koshelek TOTP Module, set up initialization parameters as described below.

All parameters are mandatory.

Parameter	Type	Description
algorythm	String	Encryption algorithm in use. Available values: HMACSHA256 HMACSHA1
passLength	Int	TOTP password length. Max. value: 10
prefix	String	Barcode prefix. Default value: CM
key	String	Secret key (hex string) required for TOTP password creation.
interval	Int	TOTP validity timeframe (in seconds).
cardSessionLength	Int	Defines length of cardSession.
delimeter	String	Separates the barcode main part and TOTP password. Cannot be empty.

Example of init() call for Passcode Verify library with sample initialization parameters:

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