Choose the integration surface
The Public API reference documents the supported /api/public/v1 endpoints. The public API and the official widget's internal APIs are different surfaces. Membership administration, full benefit discovery, review management, and all dashboard actions are not automatically available through public v1.
Authenticate correctly
- Program and token exchange: send the publishable key as
X-API-Key. - Customer endpoints: also send the customer's short-lived JWT as a bearer token. Sign identities on your server with the secret key, then exchange them through
/auth/customer-token. - Server endpoints:
/customers,/orders, and/coupons/*use the secret key as the bearer token. They do not also require a publishable key.
Build against actual response fields
Use the live available-point balance, not a sum of all historical earnings. To include used and expired vouchers, call /customer/redemptions?include_history=true. The public point-history endpoint uses page and limit; it does not implement the internal widget's include_balance option.
The public reward catalog only includes active rewards with a positive point cost. Merchant-only configuration fields are not exposed merely because they exist in the dashboard. Use the OpenAPI specification for request and response schemas; the API reference also supports MCP access.