API Access
Connect your POS, ERP, or online store directly to your Niqati data — no middleman, no waiting.
Overview
The Niqati API lets your own systems — a point-of-sale terminal, an ERP like Odoo, a Shopify/WooCommerce store, or custom software — read and write your loyalty data directly, instead of your staff working inside the Niqati app. Registering customers, checking balances, awarding points, and redeeming rewards can all happen automatically from wherever your sale actually occurs.
This page covers the in-app screen where you turn on and manage API access: creating keys, watching usage, and monitoring integrations. For the full endpoint reference, authentication details, and code samples, see the Niqati API Reference.
API access is included only with the Enterprise plan — it isn't available at any price on Pro. Within your account, only the owner can view or manage API keys; employees never see this screen, regardless of their permissions.
Turning On API Access
If your account is on Enterprise, API access is unlocked automatically — open Settings → API Access to get started. If you're not yet on Enterprise, the same screen shows what the API offers with a "Contact us to activate" button, which reaches our team through Contact Support.
Creating an API Key
- On the API Access screen, tap "New key"
- Give it a label describing where it'll be used, e.g. "Main Branch POS"
- Select scopes — the specific permissions this key should have — or use the "All" or "Read only" presets
- Confirm to generate the key
The full secret is displayed exactly once, right after creation. Copy it into your system's configuration immediately; Niqati only stores and displays a masked version (like nq_live_ab12…wxyz) afterward.
You can hold up to 10 active keys per account — enough to give each branch, POS terminal, or integration its own key with its own scopes.
Available Scopes
| Scope | Allows |
|---|---|
customers:read | View customer data and point balances |
customers:write | Register new customers |
transactions:read | View points and rewards history |
transactions:write | Add points and redeem rewards |
cards:read | View loyalty cards and rewards configuration |
webhooks:manage | Create and manage webhook subscriptions |
Grant a key only the scopes it actually needs. A POS terminal that only stamps points, for example, needs transactions:write and customers:read — not webhooks:manage.
Rotating and Revoking Keys
Open any key's detail sheet to see its scopes, rate limit, creation date, and last-used time, plus two actions:
- Rotate: Issues a new secret for the same key. The old secret keeps working for a 24-hour grace window so you can update your systems without downtime.
- Revoke: Immediately and permanently disables the key. This cannot be undone — use it when a key is compromised or no longer needed.
Monitoring Usage
The API Access screen shows a rolling 30-day summary: total requests, success rate, average response time, and how many requests were rate-limited. A separate activity feed lists your most recent API calls with their HTTP method, endpoint, and status code, so you can quickly spot a failing integration.
Integrations & Webhooks
The Integrations screen (linked from API Access) gives you a monitoring view of how your systems are connected:
- Connected platforms: status for Foodics, Odoo, Shopify, WooCommerce, or a custom integration, with last-sync time
- Webhook endpoints: each endpoint's URL, subscribed events, status, and recent delivery attempts
- Recent activity: your latest API requests across all keys
This screen is for monitoring only — webhook endpoints themselves are registered through the API using the webhooks:manage scope. See the API Reference for the endpoint details.
Available webhook events: transaction.created, points.awarded, reward.redeemed, customer.created, customer.updated, card.created, card.updated, and test.ping for verifying a new endpoint.
Next Steps
Ready to start building? Head to the full API Reference for endpoints and authentication details, or review what else Enterprise unlocks.