Developer guide
What a developer needs to connect a program to this store: the API's address, how to get a token with an API client's ID and secret and make a call (curl examples to copy), the full OpenAPI description and a Postman collection to download, the permissions, the limits and the error answers. No fee per call. Part of the API access add-on.
Steps
- Open API access → Developer guide. Copy the address: every call goes to it plus the resource, such as /customers.
- Get a token: send the client's ID and secret to /oauth/token (the first example). The token lasts 30 minutes; ask again when it ends.
- Call the API with the token in the Authorization header (the second example). Lists answer page by page.
- Press OpenAPI description for every resource and its permissions, or Postman collection to try the calls in Postman with the token already set up.
Tips
- Send an Idempotency-Key with a create, so a retry after a dropped connection never makes the record twice.
- Every answer carries X-RateLimit-Remaining; a 429 says how many seconds to wait in Retry-After.
In the app, press F1 or ? on this screen to open this guide next to your work.
This guide belongs to the API access & sandbox module. Learn more
Related guides
More guides in Settings & administration
- Login address
- Custom print formats for pre-printed paper
- Capture enquiries
- Approval policies
- Asset categories
- Branding
- Web addresses
- Site and pages
- Editing a page
- Site settings
- Token & counter set-up, kiosk and board
- Attendance set-up, kiosk & devices
- Biometric devices
- AI usage & limit
- Automation rules
- Scheduled reports
- Your accountant
- Webhooks
- Partner programme
- Store settings
- Printers & invoice printing
- Sidebar configuration
- Users
- RBAC (roles & permissions)
- View as a store role
- Notifications
- My profile
- 2-step verification
- Connect to ZATCA (Phase 2)
- Biometric devices settings
- Terminals
- Card machines
- AI connections
- Card Bridge (shop computer)
- Audit log
- Subscription & billing
- AI unanswered questions
Still need help?
Our team answers in Arabic and English by email and phone.