Overview
Credentials
Learn about App IDs, API Keys, and Scopes for authenticating with the API.
App Credentials
Each application you create receives two credentials:
| Credential | Format | Purpose |
|---|---|---|
| App ID | app_xxxxxxxxxxxxxxxx |
Identifies your application (safe to share) |
| App Secret | secret_xxxxxxxxxxxxxxxx |
Authenticates your application (keep private!) |
Keep Your Secret Safe
Never expose your App Secret in client-side code, public repositories, or logs. Treat it like a password.
API Keys
API keys are generated within applications and carry specific permissions (scopes):
API Key Format
# Test Mode Key
test_sk_abc123def456ghi789...
# Production Mode Key
prod_sk_xyz789ghi012jkl345...Available Scopes
Scopes define what operations an API key can perform:
Member Scopes
| Scope | Type | Description |
|---|---|---|
member_read |
READ | Read access to member data, validation |
member_write |
WRITE | Create and update members, request OTPs |
Card Scopes
| Scope | Type | Description |
|---|---|---|
card_read |
READ | Read cards and rewards information |
Claim Scopes
| Scope | Type | Description |
|---|---|---|
claim_write |
WRITE | Create, approve, and reject claim requests |
Referral Scopes
| Scope | Type | Description |
|---|---|---|
referral_read |
READ | Read referral stats and validate codes |
referral_write |
WRITE | Apply referral codes |
Stamps Scopes
| Scope | Type | Description |
|---|---|---|
stamps_read |
READ | Read stamp balances and history |
stamps_write |
WRITE | Add stamps and redeem rewards |
Cashback Scopes
| Scope | Type | Description |
|---|---|---|
cashback_read |
READ | Read cashback balances and history |
cashback_write |
WRITE | Credit and redeem cashback |
Managing API Keys
[Screenshot: API Keys list in developer dashboard]
1
Navigate to Developer Section
From your partner dashboard, click on "Developer" in the sidebar.
2
Select Your Application
Click on the application you want to manage keys for.
3
Manage API Keys
View existing keys, create new ones, or revoke compromised keys.
Key Rotation
We recommend rotating your API keys periodically. Create a new key, update your integration, then revoke the old key.