Skip to content

Earn 30% on every license you refer. Join the affiliate program

Agent API.

The machine-to-machine API that Integration API keys open, for POS systems, automation platforms, connected apps, and AI agents.

16 articles · In reading order

1

Agent API overview

The Agent API for machine-to-machine loyalty operations.

2

Getting started

Make your first authenticated Agent API call and choose the right key model for your integration.

3

Authentication

How Agent API keys work, security model, and authentication flow.

4

Scopes & permissions

Understanding scope enforcement and what each permission level allows.

5

Enabling & managing keys

How to create, configure, and revoke Integration API keys.

6

Error handling

Understanding structured error responses and retry strategies.

7

Audit logging

How the platform records agent API requests and how to monitor them.

8

POS integration

Build a point-of-sale integration for member lookup, balance checks, purchases, rewards, stamps, and vouchers.

9

E-commerce

Build a webshop or checkout integration using member keys for wallet access and partner keys for purchase writeback.

10

Common workflows

Practical request patterns for QR resolution, follow or unfollow, manual adjustments, and transaction reconciliation.

11

Tool discovery

Discover available API operations as machine-readable tool definitions.

12

Partner endpoints

Complete endpoint reference for partner-scoped agent operations.

13

Member endpoints

Complete endpoint reference for member-scoped agent operations.

14

Admin endpoints

Platform administration via the Agent API, covering partner management, member search, and analytics.

15

Complete endpoint reference

Every agent API endpoint across all roles. Routes, methods, scopes, parameters, and response fields.

16

Production checklist

Launch-safety checklist for Agent API integrations, including idempotency, retries, key management, and reconciliation.