Reference
API reference
Every operation of the public API v1, resource by resource, with the scope each one requires.
Every page of the reference is generated from the OpenAPI document the API serves itself: it says exactly what the API does. You will find the required scope, the parameters, the expected body, the possible answers with an example, and the curl call.
- Base address:
https://api.kivoo.africa/v1, in JSON. - Authentication:
Authorization: Bearer <API key>(see Authentication). - Pagination, dates, amounts and errors follow the conventions.
- The OpenAPI document is public:
https://api.kivoo.africa/v1/openapi.json, to generate a client or import it into your tool.
Store
Products
Orders
Customers
Payment links
- get
/v1/payment-linksList payment linkspayment_links:read - post
/v1/payment-linksCreate a payment linkpayment_links:write - get
/v1/payment-links/{id}Retrieve a payment linkpayment_links:read - patch
/v1/payment-links/{id}Update a payment linkpayment_links:write - post
/v1/payment-links/{id}/disableDisable a payment linkpayment_links:write - post
/v1/payment-links/{id}/enableEnable a payment linkpayment_links:write