/v1 surface plus three data SDKs - TypeScript,
Swift, and Kotlin - that your app embeds to give members a rewards experience:
browse offers, redeem them with points, check eligibility, read a wallet, and
chat with an embedded concierge.
The SDKs share one method surface, one configuration vocabulary, and one error
taxonomy, so a concept you learn once applies in every language. This site is the
source of truth: concept guides with code in all three SDKs, plus an interactive
API reference you can call from the browser.
Quickstart
Install an SDK, get a member token, and make your first call in under five
minutes.
Authentication
The two-token model: your backend mints short-lived member tokens with a
secret Org-API-Key.
API reference
Every endpoint, with schemas and a live “Try it” playground against the
sandbox.
SDKs
Install and usage notes for the TypeScript, Swift, and Kotlin SDKs.
The two sides of the API
The surface splits in two, and knowing which credential goes where is the single most important integration rule.Member mode
Runs in your app with a short-lived member token. Browse offers, redeem,
read eligibility and wallet, and use the concierge.
Server mode
Runs only on your backend with the secret Org-API-Key. Exchange tokens,
mint points, manage members, read analytics, and register webhooks.
What you can build
Offers and redemptions
List offers (with points pricing) and redeem them; redemptions debit points
and refund on cancel.
Points and wallet
Mint points from your backend, read balances, and page the ledger of every
credit and debit.
Members and tiers
Set member profiles and tiers from your backend; tier flows into eligibility.
Analytics
Summary, per-offer, and time-series analytics for your program.
Webhooks
Subscribe to lifecycle events with signed, retried deliveries.
Concierge
Conversations and a live message stream for an embedded assistant.