Place Info API v1.0.0
API for synchronizing partner’s places of service.
General information
The manual is intended for partner companies of Bescontact LLC that provide loyalty cards issuance in the Koshelek app using the Koshelek platform.
Place Info API is used to transfer and update list of partner’s service points (shops, restaurants, etc.) where customers can use loyalty cards issued in the Koshelek app.
Connecting to API
Place Info API is provided by the Koshelek host. The following request parameters are provided for a partner in order to get access:
| Parameter | Description |
|---|---|
| host:port | Address and port of the Koshelek host providing the API. |
| login:password | Username and password for API requests authorization. |
| offerId | Partner’s loyalty program ID in the Koshelek platform. The parameter value is required and must be specified in headers of API requests. |
Authorization
The HTTPS protocol is used. HTTP Basic Authentication (RFC 7617) mechanism should be used for API requests authorization. Credentials for authorization are transferred in the Authorization HTTP header.
Encoding
Both API requests and responses should use the UTF-8 encoding.
HTTP codes
If the request has been successfully processed, the Koshelek host returns an HTTP response containing HTTP status code 200, and the body with a payload that is described in the request documentation.
If an error occurred during the request processing, it is returned with an HTTP response containing HTTP status code 422 and a string with the error description in the body (UTF-8 encoding is used).