Documentation
Everything you need to get started
Guides, API references and integration examples for your aperatif.ai platform.
From your first login to a fully connected business.
Quickstart
01
Get your API key
Generate an API key from your workspace settings. Every request is authenticated and scoped to your company.
export APERATIF_API_KEY="sk_live_…"
# Keys are managed under Settings → API access02
Sync your customers
Push customers from your POS, website or existing systems. They appear instantly in CRM and loyalty.
curl -X POST https://api.aperatif.ai/v1/customers \
-H "Authorization: Bearer $APERATIF_API_KEY" \
-d '{"name": "Sara Khan", "phone": "+971500000000"}'03
Award loyalty points
Record a purchase and points are calculated automatically using the rules configured for your programme.
curl -X POST https://api.aperatif.ai/v1/loyalty/transactions \
-H "Authorization: Bearer $APERATIF_API_KEY" \
-d '{"customer_id": "cus_71k", "amount": 240}'