Additional API Requests

Issued loyalty cards maintenance

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/

The API methods described below are optional for implementation. Usage of these methods must be defined by Cardsmobile at the stage of scenario approval.

Request List of User's Phone Numbers with Special Conditions of Loyalty Program

GET https://<base-URL>/v1/card/getAllUsers

The request returns a list containing phone numbers of registered users. It is formed by the partner according to special conditions.

200: OK The request is processed. The response body contains an array with phone numbers of all existing and active customers included into the loyalty program that meet a certain criterion. If such customers are not found, the array is empty:

A. List of users

[ // list of phone nubers without '+' prefix
   "79000123456",
   "79000123457"
]

B. There are no users

[]

422: Unprocessable Entity An error occurred. The response body contains information on the error (code and description):

{
  "code": "123",
  "description": "DBMS server is not available"
}

Example of the request:

GET /v1/card/getAllUsers

List forming criteria

Rules of forming the list should be defined on the partner's side according to partner's business logic. For example, it can be a list containing phone numbers of customers that can issue the "corporate employee card" with special privileges within the loyalty program.

Request Extended List of Users with Special Conditions of Loyalty Program

GET https://<base-url>/v1/card/getAllUsersExtended

The request returns a list containing phone numbers and additional parameters (if available) of registered users. It is formed by the partner according to special conditions of the loyalty program.

200: OK The request is processed. The response body contains an array with phone numbers and additional parameters of all existing and active customers included into the loyalty program that meet a certain criterion. If such customers are not found, the array is empty:

A. List of users

[
  {
    "phone": "79000123456", // phone number without '+' prefix
    "params": [             // additional parameters, if available 
      {
        "name": "",         // parameter name
        "value": ""         // parameter value
      }
    ]
  }
]

B. There are no users

[]

422: Unprocessable Entity An error occurred. The response body contains information on the error (code and description):

{
  "code": "123",
  "description": "DBMS server is not available"
}

Example of the request:

GET /v1/card/getAllUsersExtended

List forming criteria

Same as for the request above.