Public REST API
Synchronize products, read and adjust inventory stock counts, query customer records, and inspect orders.
The Akoole Developer Platform enables merchants and partners to programmatically manage products, sync stock levels across sales channels, fulfill orders, and receive real-time HTTP webhooks.
All public API endpoints are served through a dedicated, isolated gateway architecture with strict tier-based rate limiting and cryptographic request auditing.
Public REST API
Synchronize products, read and adjust inventory stock counts, query customer records, and inspect orders.
Outbound Webhooks
Receive real-time push notifications signed with HMAC-SHA256 whenever sales, stock, or catalogue events occur.
The API gateway is versioned under /developer/api/v1/:
| Environment | Base URL |
|---|---|
| Production | https://api.akoole.com/developer/api/v1 |
| Local Development | http://api.akoole.localhost/developer/api/v1 |
All requests must be sent over HTTPS (or HTTP for local dev) and specify Accept: application/json.
HMAC-SHA256 with your unique signing secret (whsec_...)./developer/api/v1/* is audited with method, path, HTTP status, duration, IP, user-agent, and actor context.In the merchant dashboard (app.akoole.com), navigate to Settings → API Keys (or press Cmd+K and search “API Keys”). Create a key with the desired scopes (e.g. catalogue.view, inventory.view).
Send a GET request to verify connectivity:
curl -X GET "https://api.akoole.com/developer/api/v1/health" \ -H "Accept: application/json"Response (200 OK):
{ "status": "ok", "service": "developer-platform"}Authenticate your request by supplying your Bearer token and Organisation UUID:
curl -X GET "https://api.akoole.com/developer/api/v1/products?limit=10" \ -H "Authorization: Bearer akoole_live_YOUR_API_KEY" \ -H "X-Organisation-Uuid: 01HZX8EXAMPLEORG0000000000" \ -H "Accept: application/json"