Skip to content
Beexar Docs

Introduction

What is Beexar?

Section titled “What is Beexar?”

Beexar is a Game Provider Platform (GPP) that delivers casino games to operators via a simple HTTP API. Operators embed Beexar games into their platforms using iframes and handle financial operations through the Seamless Wallet integration pattern.

Available Games

Section titled “Available Games”

Dice

Over/Under betting game. Single-step rounds. Provably fair.

Plinko

Ball-drop game with configurable rows and risk levels. Single-step rounds. Provably fair.

Crash

Multiplayer crash game with rising multiplier. Players cash out before the crash. Provably fair. Configurable RTP.

Candy Cash

Cut the rope and drop through a candy field — every candy hit adds to the win. Bonus buys, up to 5,000× the bet. The bet is debited when the drop starts, a win is credited when it lands. Provably fair.

Mine Cash

Hit the holes of a mine: every gnome lifts the win up a ladder of multipliers, dynamite takes it all. Cash out any time after the first gnome. Bonus buy. Provably fair.

Seamless Wallet Pattern

Section titled “Seamless Wallet Pattern”

Beexar does not hold player funds. Instead, the operator’s wallet is the single source of truth for player balances. During gameplay, Beexar sends HTTP requests to the operator’s server to:

  1. Check balance — before showing the game UI
  2. Bet and win — debit the bet and credit the win in a single atomic request (/betwin)
  3. Rollback — reverse a failed or cancelled action
  4. Finish round — signal that a round is complete (only when not already closed by /betwin)

This is known as the Seamless Wallet pattern.

sequenceDiagram
    participant Player
    participant Beexar as Beexar (Game Provider)
    participant Operator as Operator Wallet

    Player->>Beexar: Plays game
    Beexar->>Operator: POST /balance
    Operator-->>Beexar: { balance: "500.00" }
    Beexar->>Operator: POST /betwin (bet + win, atomic)
    Operator-->>Beexar: { balance: "515.00", transactions }

Glossary

Section titled “Glossary”
Term Definition
Operator Casino or gaming platform that integrates Beexar games. Also referred to as “Casino” or “Wallet”.
Beexar Game Provider — serves game content and manages game logic.
Gateway API Beexar’s external API for operators to launch game sessions (POST /api/v1/softswiss/launcher/real, per integration platform).
Wallet API HTTP endpoints that the operator implements. Beexar calls these during gameplay.
Session Token 64-character hex token identifying a player’s game session. Embedded in the launch URL.
Round A complete game cycle (one or more bet/win/rollback transactions), identified by round_id.
Transaction A single financial operation within a round (bet, win, or rollback), identified by id_provider.
round_id Game round identifier on Beexar’s side. All transactions in a round share the same round_id.
id_provider Unique identifier for a single transaction, generated by Beexar. Used for idempotency.
game (slug) Short name identifying the game, e.g. "dice" or "candy-cash".
GATEWAY_URL Beexar Gateway API base URL, e.g. https://gateway.beexar.com (provided by Beexar).
AUTH_TOKEN Operator’s API secret, used as the HMAC-SHA256 signing key (provided by Beexar).

Before Integration

Section titled “Before Integration”

Before starting the integration, ensure both parties have exchanged the required information:

What the operator provides to Beexar

Section titled “What the operator provides to Beexar”
  • 4 callback URLs for wallet endpoints:
    • balance_url — e.g. https://casino.example.com/wallet/balance
    • betwin_url — e.g. https://casino.example.com/wallet/betwin
    • rollback_url — e.g. https://casino.example.com/wallet/rollback
    • finish_url — e.g. https://casino.example.com/wallet/finish

What Beexar provides to the operator

Section titled “What Beexar provides to the operator”
  • Operator slug (casino_id) — identifies the operator in launch requests and game URLs
  • API Secret (AUTH_TOKEN) — used as the key for HMAC-SHA256 request signing
  • Gateway URL (GATEWAY_URL) — e.g. https://gateway.beexar.com
  • Game list — available games with slugs, RTP, and feature details
  • Test credentials — a test operator for integration testing (demo mode + Integration Test Game)

Next Steps

Section titled “Next Steps”