Talk to the Spaaza API
This skill allows an AI agent to “talk” to the Spaaza API on your behalf using natural language instructions.
It can:
- authenticate an admin user session,
- retrieve information about chains, campaigns, users, vouchers, and baskets,
- carry out approved API changes,
- report results clearly.
This is similar to common Spaaza Console tasks, but text-based.
Security and credentials
This skill is designed to be security-first:
- credentials should be requested only when required,
- credentials and OTP/session data should be used only for the active session,
- staging should be used by default unless production is explicitly requested.
Current recommendation: credentials are entered per session.
Environments and documentation
- Staging (
test01):https://apistage0.spaaza.com - Production (
prod):https://api0.spaaza.com
Deployment flow:
develop->test01master->prod
Documentation:
- Staging docs:
https://docs-test01.spaaza.com - Production docs:
https://docs.spaaza.com
Agents should read the login documentation before creating login requests. Agents should also read the relevant endpoint documentation before consuming other API endpoints.
Endpoint catalogue (documented endpoints)
These endpoints are amongst the many already documented in this site and are useful for AI-assisted workflows.
| Endpoint | Typical use | Documentation |
|---|---|---|
POST /auth/login | Start login flow, including admin 2FA initiation | User login |
POST /auth/session | Complete admin 2FA and create session | Create a user session when provided with valid credentials |
GET /internal/get-campaigns | List campaigns for a chain | Getting campaigns |
GET /internal/get-campaign | Get details for one campaign | Get a campaign |
POST /auth/get-basket-price | Evaluate basket and campaign effects | Get basket adjustments |
POST /auth/add-basket | Add/finalise basket transactions | Adding baskets |
GET /internal/get-user | Retrieve user profile and status | Get user |
GET /internal/get-businesses | Retrieve businesses for a chain | Getting all businesses |
GET /internal/get-vouchers | Inspect voucher state and eligibility | Get vouchers |
Skill file
- Repository file: