API Overview
Welcome to the eshopOS API. Our API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Base URL
All public API requests are made to your public API host:
https://api.dukalinks.co.ke
Local development:
http://localhost:8080
Public endpoints live under /api/public/v1.
Versioning
When we make backwards-incompatible changes to the API, we release a new major version. The current version is v1.
- Breaking changes: Require a new version (e.g.,
v2). - Non-breaking changes: Added as incremental updates to the current version.
Format
All request bodies must be JSON, and all responses will be returned in JSON.
{
"status": "success",
"data": { ... }
}
Idempotency (Coming Soon)
We are currently developing support for idempotency keys to prevent duplicate processing. The Idempotency-Key header described below is not yet processed by the API.
For operations that create or modify data, we plan to support idempotency keys. Pass an Idempotency-Key header with a unique string.
Idempotency-Key: <unique_string>