API access & sandbox
Connect your own software and partners, safely
API access & sandbox in one picture
Follow the data from what you enter to what you get back. Every step below happens inside StartERP, with nothing to retype.
- Your other programs
- Client ID and secret
- Scopes and IP list
API access & sandbox
- Issues short-lived tokens
- Limits calls per minute
- Logs every call
- Systems in sync
- Sandbox to test safely
- Developer guide
Connect anything, safely
Start using API access & sandbox in 3 steps
The same three steps wait for you as a checklist on the module's first screen, and most tick themselves as you do them.
- Step 1
Create an API client
Name the program and get its ID and secret.
- Step 2
Choose its scopes
What it may read or change, and from where.
- Step 3
Follow the developer guide
Examples, OpenAPI file and a sandbox store.
Add it when you sign up, or any time later from Subscription & billing.
What it does for your business
Give each program that should reach your store, an accounting tool, your online shop, a delivery partner, its own API client with a client ID and a secret. Tick which areas it may read or change, list the IP addresses it may call from and how many calls a minute it may make; it never gets more than the person who made it. Programs get short-lived OAuth2 tokens, every call is logged, a new secret ends the old one at once, and a sandbox store with sample products lets developers try anything without touching real data. The developer guide has the address, ready-to-copy examples, the full OpenAPI description and a Postman collection. No fee per call.
A client per program, with read or change per area and never more than its maker
Short-lived OAuth2 tokens, IP allow-list, rate limit and a 30-day request log
A sandbox store with sample data, reset any time
Signed webhooks for Zapier and Make, a developer guide with OpenAPI and Postman; no fee per call
Inside the module
Real screens from a StartERP demo store. Tap a screen to see it full size.
Step-by-step guides
- API clientsConnect 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.
- WebhooksSend each new or changed sale, return, quotation, purchase, customer, vendor, product or expense to your own system, Zapier or Make the moment it is saved. Part of the API access add-on.
- Developer guideWhat 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.
Frequently asked questions
Is API access & sandbox included in StartERP?
API access & sandbox is an add-on module. Add it when you sign up or any time later from Subscription & billing, and pay only for the modules you use.
Can I try API access & sandbox before I pay?
Yes. Open a demo store for your business type to use it with sample data, or start the 15-day free trial with your own data. No card is needed.
Does API access & sandbox work in Arabic and on a phone?
Yes. Every StartERP screen works in Arabic and English, on a computer, tablet or phone, and users and devices are unlimited.
Start selling with a ZATCA-ready POS today
Prices on request: pick the modules your business needs and we will email you a quote. Subscribe or buy the licence once. Unlimited users and devices. Every store starts with a 15-day free trial.
Request pricing · Need a module we don't have yet? Request it