Developer documentation
Connect your tools to your Kivoo store: read your orders and customers, manage your products and payment links, receive every sale as it happens.
The Kivoo API gives your programs access to your store: a spreadsheet that fills itself at each sale, a CRM that knows your customers, an automation (Zapier, Make, n8n) that publishes your products, your own website. It lives under https://api.kivoo.africa/v1, answers in JSON and is authenticated with an API key of the store.
What you can do
- Read your store, its products (downloadable products, events, courses, licenses), orders, customers and payment links, with pagination and search.
- Update a product (title, texts, prices) and publish it, move it back to draft or archive it. What publishing needs depends on its type: see Conventions.
- Create and update a customer, never creating a duplicate.
- Manage your payment links: create, update, pause and resume them.
- Receive the webhook events of your store (
order.paid,customer.created…) on your server, signed, with automatic retries. - Sell licenses: check from your server the license key a buyer enters in your software, or have the users of your app pay through a checkout session.
Quickstart
Create a key, make your first call and read the answer.
API reference
Every operation with its scope, a curl example and a sample response.
Webhooks
Receive your sales as they happen and check they really come from Kivoo.
Accept payments from your app
Have the users of your SaaS pay and activate their account on the webhook.
A first call
The ten latest paid orders of your store:
curl --get https://api.kivoo.africa/v1/orders \
-H "Authorization: Bearer kv_live_EXAMPLE0000000000000000000000000000000000" \
-H "Accept: application/json" \
-d status=PAID \
-d pageSize=10The answer lists the orders (data), the requested page and the total count (total): the rules shared by every list are in Conventions.
A key opens one store
An API key belongs to a single store: the addresses of the API therefore never carry a store id. If you run two stores, create a key in each.