Basics
Table of contents
2.1 Authentication
Beginning from v1, all API calls require Authentication. The service uses HTTP signature based authentication.
This means to successfully authenticate with the APIs you must provide a valid signature to your request.
This consists in adding an element to the header of the request:
| Header | Description |
|---|---|
X-SIGNATURE | The signature header of the request |
See section 4.1 for information about how to create a valid signature.
2.2 HTTPS
All API calls have to be made through a secure https connection.
2.3 Errors
KENZ'UP uses conventional HTTP response codes to indicate the success or failure of an API request. In general: codes in the 2XX range indicate success, codes in the 4XX range indicate an error with the submitted data or an authentication error, and codes in the 5XX range indicate an error with KENZ'UP’s platform. If an error occurs, a common response format will be respected:
Response Code: 404
{
"error": "not_found",
"message": "The requested resource doesn't exist."
}
2.4 Versioning
The KENZ'UP api is versioned at the endpoint level. If breaking changes are required on an endpoints, a new version of this endpoint will be created (eg: api/v2/...), while api/v1/... will still remain in use until participating shops integrate with the new v2 endpoint.
3. Endpoints
3.1 Base URLs
We currently have three base URLs for three environments:
| Environment | Endpoint |
|---|---|
| Development | https://dev-app.kenzup.com/ |
| Staging | https://staging-app.kenzup.com/ |
| Production | https://app.kenzup.com/ |
Version History
| Version | Date | Changelog |
|---|---|---|
| V. 0.1 | 27/02/2020 | Initial endpoint definition |
| V. 0.2 | 16/03/2020 | Update endpoint response structure |
| V. 0.3 | 14/04/2020 | Add authentication requirements Update endpoints to v2. Deprecate cancel and refund endpoints. |
| V. 0.4 | 28/04/2020 | Update staging/production base URLs |
| V. 0.5 | 01/05/2020 | Add new staging URL to the testing script Make testing script more verbose Add payload hashing requirements Add more information about testing values |
| V. 0.6 | 06/06/2020 | Remove payload generation requirements |
| V. 0.7 | 01/10/2020 | Added optional customer restriction option to earn and payment request endpoints |
| V. 0.8 | 09/12/2020 | Added deeplink field & M-commerce section |
| V. 0.9 | 07/07/2021 | Added deeplink field & M-commerce section |
| V. 0.10 | 02/12/2024 | Added Mpay partner cashin |