Create scoped Admin API keys so external tools can read and process orders, add funds, edit users and reply to tickets. Built-in docs and a request log.
What it is
The Admin API exposes back-office actions to your own scripts, dashboards or automation tools, with fine-grained permissions per key.
How it works
- Create a key with a name and status, then tick its scopes: Orders (list, single, view email, provider URL, provider charge, provider response, API order ID; resend, change status, cancel and refund, set partial, set start count, set remains), Transactions (list, single, add fund), Users (list, single, edit) and Tickets (list, single, reply).
- Generate the key from the Key popup; it is shown once and stored hashed, and can be regenerated any time.
- The documentation page lists every endpoint with parameters and examples.
- Every request is recorded under Logs > Admin API Logs.
- Only owner and support admins can manage keys.
Where to find it
Admin > Settings > Admin API.