Game Play API Overview
The Game Play API powers the embeddable widget and mobile SDKs. All endpoints require a public key via the X-API-Key header.
Base URL
Section titled “Base URL”https://api.gamifyhost.comAuthentication
Section titled “Authentication”Include your public key in every request:
X-API-Key: pk_live_your_public_keySee Authentication for details.
Endpoints
Section titled “Endpoints”| Method | Path | Description |
|---|---|---|
GET | /v1/games | List active games |
GET | /v1/games/:gameType/config | Get game configuration |
POST | /v1/games/play | Play a game |
GET | /v1/leaderboard | Get leaderboard |
GET | /v1/users/:userId/sdk-balance | Get user balance |
GET | /v1/users/:userId/plays | Get user play history |
Game Types
Section titled “Game Types”| Game | Identifier | Description |
|---|---|---|
| Neon Wheel | NEON_WHEEL | Spin-the-wheel with weighted segments |
| Cosmic Slots | COSMIC_SLOTS | Slot machine with symbol matching |
| Enigma Boxes | ENIGMA_BOXES | Pick-a-box mystery reward |
Reward Structure
Section titled “Reward Structure”Every game play returns a reward object:
{ "tier": "rare", "type": "cashback", "value": 50, "label": "$0.50 cashback"}Tiers: epic, rare, common
Types: cashback, xp, points, item, special