API clients
Connect your own software, an accounting tool, your online shop or a partner to this store. Each API client gets a client ID and a secret, the areas it may read or change, an optional list of IP addresses and a rate limit; its calls are logged for 30 days. The sandbox is a hidden copy of the store with sample products for trying everything safely. Part of the API access add-on.
Steps
- Open API access → API clients and press New client. Name it after the program that will use it, such as Accounting sync.
- Tick Read or Change for each area it needs, and nothing more. Change brings Read with it. A client never does more than you may do yourself.
- Optionally list the IP addresses it calls from (one per line, ranges like 198.51.100.0/24 work) and change the requests a minute, then press Create.
- Copy the client ID and the secret into the program's settings now: the secret is shown only once. The developer guide shows how the program asks for a token and makes its first call.
- Recent calls shows each call with its result. New secret stops the old secret and its tokens at once; Switch off pauses a client; Remove ends it.
Tips
- Press Create the sandbox, then tick Works on the sandbox when you make a client: its token reaches only the sandbox, never your real sales or stock. Reset the sandbox starts it over.
- Make one client per program, so switching one off never stops the others. A store can have up to 10.
- In a demo store the clients stay in your browser and their keys are samples that open nothing on the server.
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
- 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.