Agent API.
Machine-to-machine API for AI agents, POS systems, and automation tools.
Agent API overview
The Agent API for machine-to-machine loyalty operations.
Getting started
Make your first authenticated Agent API call and choose the right key model for your integration.
Authentication
How Agent API keys work, security model, and authentication flow.
Scopes & permissions
Understanding scope enforcement and what each permission level allows.
Enabling & managing keys
How to create, configure, and revoke Agent API keys.
Error handling
Understanding structured error responses and retry strategies.
Audit logging
How the platform records agent API requests and how to monitor them.
POS integration
Build a point-of-sale integration for member lookup, balance checks, purchases, rewards, stamps, and vouchers.
E-commerce
Build a webshop or checkout integration using member keys for wallet access and partner keys for purchase writeback.
Common workflows
Practical request patterns for QR resolution, follow or unfollow, manual adjustments, and transaction reconciliation.
Tool discovery
Discover available API operations as machine-readable tool definitions.
Partner endpoints
Complete endpoint reference for partner-scoped agent operations.
Member endpoints
Complete endpoint reference for member-scoped agent operations.
Admin endpoints
Platform administration via the Agent API, covering partner management, member search, and analytics.
Complete endpoint reference
Every agent API endpoint across all roles. Routes, methods, scopes, parameters, and response fields.
Production checklist
Launch-safety checklist for Agent API integrations, including idempotency, retries, key management, and reconciliation.