Architecture Overview
The KopiPOS platform is built on a modern, RESTful architecture. Our APIs are designed to have predictable, resource-oriented URLs, use standard HTTP response codes, and return JSON responses.
Whether you are building a custom ordering app, integrating with an existing ERP, or syncing data to an accounting software, our platform provides the tools you need.
Base URL
https://api.kopipos.com/v1/Authentication
KopiPOS uses API keys to authenticate requests. You can view and manage your API keys in the KopiPOS Dashboard.
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
// Example requesting an endpoint using Bearer auth
curl -X GET https://api.kopipos.com/v1/orders \
-H "Authorization: Bearer sk_live_your_secret_key"Webhooks
Webhooks allow you to build or set up integrations that subscribe to certain events on KopiPOS. When one of those events is triggered, we'll send a HTTP POST payload to the webhook's configured URL.
- order.created: Triggered when a new order is placed.
- payment.succeeded: Triggered when a payment is successfully processed.
- inventory.low: Triggered when an item falls below its low stock threshold.