Skip to main content

Environment Setup

Base URL

All API requests use the same base URL for both Test and Live environments:
https://api.gameball.co/api/v4.0
Switch between Test and Live environments by using your Test or Live API Keys. The base URL remains the same for both environments.

API Credentials

Retrieve your API Key and Secret Key from the Gameball Dashboard: Dashboard Path: Settings → Account Integration → API Keys You’ll need:
  • API Key: Your Gameball API key
  • Secret Key: Your Gameball API secret

Authentication Method

All API requests must include authentication headers:
curl -X GET 'https://api.gameball.co/api/v4.0/integrations/customers/{customerId}/balance' \
  -H 'APIKey: YOUR_API_KEY' \
  -H 'SecretKey: YOUR_SECRET_KEY'

Security Best Practices

Always use HTTPS for all API calls. Never send API credentials over unencrypted connections.
  • Store API credentials securely in your POS system configuration
  • Never expose API keys in client-side code or logs
  • Rotate API keys periodically for enhanced security
  • Use hash validation for QR code-based redemptions

Next Steps

Once you have your API credentials configured, proceed to:
  1. Customer Management - Learn how to register customers at checkout
  2. Customer Balance - Retrieve customer loyalty information