Register Your App
Register your iOS, Android, or Web app to get an app ID and API key for SDK integration.
Create an App
Open the Apps page
In the dashboard, navigate to Apps and click Create App.
Select your platform and fill in the details
Choose iOS, Android, or Web, then fill in the platform-specific fields:
| Field | Platform | Required | Description |
|---|---|---|---|
Bundle ID | iOS | Yes | Bundle identifier (e.g., com.opay.app) |
Apple App ID | iOS | No | App Store ID (numeric) |
App Store URL | iOS | No | Full App Store URL (used for click redirects) |
Package Name | Android | Yes | Package name (e.g., com.opay.app) |
Play Store URL | Android | No | Full Play Store URL (used for click redirects) |
Domain | Web | Yes | Website domain |
Save the app
Click Create. You’ll see your app’s detail page with the App ID (a UUID). Copy it — you’ll need it for SDK initialization.
Generate an API Key
Open API Keys
On your app’s page, go to the API Keys tab and click Generate Key.
Name your key
Enter a descriptive name (e.g., “Production SDK Key”) and click Generate.
Copy the key immediately
The full API key (format: ak_xxx) is displayed once. Copy and store it securely.
Save this key immediately! The full key is shown only once. If you lose it, you’ll need to generate a new key.
What You Have Now
After these steps, you have two things needed for SDK integration:
- App ID — A UUID from app creation (e.g.,
770e8400-e29b-41d4-a716-446655440000) - API Key — From key generation (e.g.,
ak_abc123def456ghi789)
API Access
These steps can also be done programmatically via the REST API. See Apps API Reference and API Keys Reference.
Next Step
Choose your SDK:
- Web SDK — For websites and web apps
- iOS SDK — For native iOS apps (Swift)
- Android SDK — For native Android apps (Kotlin)
- React Native SDK — For cross-platform React Native apps