Quick Start

Create an API Key

Go to the API Keys page and create a new key. Select the scopes you need (or use Full Access for development). Copy the key immediately — it is shown only once.

Make Your First API Call

Use the key to list your stores. Replace the placeholder with your actual API key and domain.

curl -X GET https://your-domain.com/api/v2/stores \
  -H "X-API-Key: flash_sk_your_key_here" \
  -H "Content-Type: application/json"

# Expected response:
# { "stores": [...], "total": 2 }

Query a Member

Fetch the list of loyalty members. Add query parameters to filter by status or paginate results.

curl -X GET "https://your-domain.com/api/v2/members?status=active&limit=5" \
  -H "X-API-Key: flash_sk_your_key_here"

# Expected response:
# {
#   "members": [
#     { "id": "m_abc123", "name": "Alice", "status": "active", "points_balance": 1200 }
#   ],
#   "total": 42
# }

Award Points

Use a POST request to award loyalty points to a member. The response includes the new balance.

curl -X POST https://your-domain.com/api/v2/members/m_abc123/points \
  -H "X-API-Key: flash_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 500,
    "description": "Welcome bonus"
  }'

# Expected response:
# { "transactionId": "txn_xyz", "balance": 1700 }