Getting Started
Register as an operator and set up your Phoenix Games integration
To integrate with Phoenix Games, you'll need to register as an Operator and provide the necessary credentials and configuration.
Environments and Demo Mode
Phoenix Games operates in two environments to support your development and production needs:
Environments
Environment | Purpose | Game URL | Operator API |
---|---|---|---|
Staging | Development, testing, integration | https://games.staging.phoenixbet.io | https://operators.staging.phoenixbet.io |
Production | Live operations, real money | https://games.phoenixbet.io | https://operators.phoenixbet.io |
- Use staging during development, testing, and integration phases
- Switch to production only when ready for live operations with real money
- Both environments require separate operator registration and configuration
Demo Mode
Phoenix Games supports demo mode for showcasing games without real money:
- No Authentication Required: Demo games don't need JWT tokens
- Virtual Credits: Players use virtual currency for betting
- Full Game Experience: Demo mode provides the complete game experience
- Perfect for Testing: Ideal for integration testing and user previews
To use demo mode, simply add ?demo=true
to any game URL:
https://games.phoenixbet.io/{game_id}?demo=true
Demo mode is available in both staging and production environments.
RSA Key Generation
Before registering, you'll need to generate an RSA public/private key pair. The public key will be shared with Phoenix Games for request verification, while you'll keep the private key secure for signing your requests.
Using OpenSSL (recommended):
# Generate private key
openssl genrsa -out private_key.pem 2048
# Extract public key
openssl rsa -in private_key.pem -pubout -out public_key.pem
Using PowerShell (Windows 10+):
# Generate key pair
$rsa = [System.Security.Cryptography.RSA]::Create(2048)
$privateKey = $rsa.ExportRSAPrivateKey()
$publicKey = $rsa.ExportRSAPublicKey()
# Save to PEM format
[System.IO.File]::WriteAllText("private_key.pem", "-----BEGIN RSA PRIVATE KEY-----`n" + [Convert]::ToBase64String($privateKey, [Base64FormattingOptions]::InsertLineBreaks) + "`n-----END RSA PRIVATE KEY-----")
[System.IO.File]::WriteAllText("public_key.pem", "-----BEGIN PUBLIC KEY-----`n" + [Convert]::ToBase64String($publicKey, [Base64FormattingOptions]::InsertLineBreaks) + "`n-----END PUBLIC KEY-----")
Using OpenSSL:
# Generate private key
openssl genrsa -out private_key.pem 2048
# Extract public key
openssl rsa -in private_key.pem -pubout -out public_key.pem
Using OpenSSL:
# Generate private key
openssl genrsa -out private_key.pem 2048
# Extract public key
openssl rsa -in private_key.pem -pubout -out public_key.pem
Using ssh-keygen (alternative):
# Generate key pair
ssh-keygen -t rsa -b 2048 -m PEM -f private_key.pem
# Convert to proper format
openssl rsa -in private_key.pem -pubout -out public_key.pem
Operator Registration
To become an Operator, you must provide the following information:
Field | Description |
---|---|
name | Unique name for your platform |
public_key | RSA public key (used to verify signed requests from you) |
allowed_hosts | List of IPs/domains allowed to communicate with Phoenix |
api_url | Base URL for your API that Phoenix will call |
Registration Process
- Generate RSA Keys - Follow the instructions above for your operating system
- Prepare Information - Gather your platform details and API endpoint URL
- Submit Registration - Contact Phoenix Games with your registration details
- Receive Operator ID - Once approved, you'll receive a unique Operator ID
Important Notes
- Keep your private key secure - never share it or commit it to version control
- Your
api_url
must be accessible from Phoenix Games servers allowed_hosts
should include all domains/IPs where you'll embed Phoenix games- The public key format should be PEM (as generated by the commands above)
Once registered, you'll be ready to configure your game instances and implement the required API endpoints.
Game Configuration
After registration, you'll need to configure game instances. Each game can have multiple instances with different configurations for currencies, wager limits, and other business rules.
Instance Creation Process
Game instance creation is currently a manual process:
- Contact Phoenix Games with your desired game and configuration details
- Provide configuration parameters as specified below
- Phoenix Games creates the instance and provides you with the Instance ID
- Use the Instance ID in your client integration and API calls
Configuration Parameters
When requesting a game instance, provide the following configuration:
Field | Type | Description |
---|---|---|
currency | string | ISO currency code (e.g., "USD", "ETB", "EUR") |
min_wager | float | Minimum bet amount |
max_wager | float | Maximum bet amount |
max_win | float | Maximum win possible for the game |
Example Configuration Request
{
"game": "aviator",
"currency": "USD",
"min_wager": 1.00,
"max_wager": 1000.00,
"max_win": 10000.00
}
Multiple Instances
You can request multiple instances of the same game for different use cases:
- Different Currencies: Separate USD, EUR, and ETB instances
- Player Tiers: VIP players with higher limits, regular players with standard limits
- Regional Settings: Different wager limits based on local regulations
- Risk Management: Various max_win limits for different player segments
Important Notes
- Max Win Display: The
max_win
value will be displayed in the game UI to inform players of the maximum possible win - Instance IDs: Each instance receives a unique ID that you'll use in JWT tokens and API calls
- Configuration Updates: Contact Phoenix Games to modify existing instance configurations
- Testing: Request separate test instances for staging/development environments
Best Practices
- Set appropriate wager and win limits based on your risk management policies
- Consider your target audience when configuring currency and limits
- Plan for different player segments and regional requirements upfront