Smile.io

API keyE-commerceOrg connection

Org-level connection

Smile.io is connected once at the org level by an admin. The credential is shared across all groups that have been granted access — individual team members don't need to connect their own accounts.

Getting your API key

In Smile Admin, go to Settings → API keys and click "Create API key".

Give it a name (e.g. "On Belay") and select ONLY the scopes you want On Belay to have. For read-only access, choose the :read scopes and leave every :write scope unchecked.

Copy the key (it starts with "api_") — Smile shows it once.

Paste it in the API Key field below.

Private Keys are the legacy credential and are being phased out; create an API key instead. Scopes are set on the key itself in Smile, so a key without a :write scope cannot write no matter what On Belay permits.

Ready to connect?

Permissions (scopes)

These are the data scopes On Belay can be granted for Smile.io. Your org admin controls which scopes are enabled per group.

Scope	Description	Access
`customer:read`	Read loyalty customers & balances	Read only
`points_transaction:read`	Read points history	Read only
`points_product:read`	Read redemption options	Read only
`points_settings:read`	Read points program settings	Read only
`earning_rule:read`	Read earning rules	Read only
`vip_tier:read`	Read VIP tiers	Read only
`reward_fulfillment:read`	Read issued rewards	Read only
`points_transaction:write`	Add or deduct points	Read / Write
`activity:write`	Record rewardable activities	Read / Write
`points_purchase:write`	Redeem points for rewards	Read / Write
`customer_identity:write`	Link external customer records (OAuth apps only)	Read / Write

Troubleshooting

"Invalid API key" or "Unauthorized" error

Double-check that you copied the full key without any leading/trailing spaces. Some platforms show a truncated preview — make sure to copy the full token. If the key was generated with restricted scopes, verify it includes the permissions listed above.

Connected but Claude can't access data

Check that your group has been granted access to this integration in On Belay → Groups → [your group] → Integrations. Also verify the specific scopes your group is permitted to use match what your query requires.

The key expires or stops working

Some API keys have expiration policies. Generate a new key in Smile.io and update it in On Belay → Integrations → Smile.io → Update key. Consider creating a dedicated service account or machine user for On Belay so the key isn't tied to a personal account.

Still stuck? We're happy to help.

Contact support →