Offline Integration Implementation
Cardsmobile Loyalty Offline Service implementation principles
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:
Cardsmobile and a partner exchange files through a file storage deployed in a secured zone at the Cardmobile platform. For file exchanging, file transfer protocol sFTP is used. Interaction scheme is presented in the figure below.
File Access Authentication
For connection, the username and password generated by Cardsmobile are used. The following connection parameters are provided to the partner:
| Parameter | Description |
|---|---|
host:port | Address of the Cardsmobile host where the sFTP server operates. |
login:password | Username and password to authorize access of the partner by sFTP server. |
Transferred Data
Cardsmobile and a partner exchange the following registries (each registry is transferred as a separate file):
Registry of issued loyalty cards. The registry contains data on loyalty cards issued by the partner in its sale points and also on loyalty cards issued for the partner in the Koshelek app. The registry is regularly transmitted from the partner to Cardsmobile.
Registry of reserved loyalty card numbers. The registry contains loyalty card numbers reserved by the partner for issuance in the Koshelek app. The registry is regularly transmitted from the partner to Cardsmobile when it is required (to avoid lack of numbers).
Registry of loyalty cards issued by Cardsmobile. The registry contains data on loyalty cards issued by Cardsmobile platform for the partner in the Koshelek app. The registry is regularly transmitted from Cardsmobile to the partner.
In addition to the registries of cards, a partner must also provide a barcode format of the cards to Cardsmobile (the format is specified once at the preparation stage).
File Requirements
All the registry data is transmitted in compressed CSV files (ZIP algorithm should be used).
The files must be encoded with the UTF-8 encoding.
The ; character is used as a value delimiter.
The header is expected at the first line of the file, so this line is ignored.
Last updated
