Balloon Boom Slot API Documentation for UK Developers

/en /por

This guide offers UK engineers and operators the specifications needed to integrate the Balloon Boom Slot game https://balloonboom.net. You’ll see the API interfaces, payload formats, and setup options here. Following these steps allows you to integrate the game to your iGaming site, adhere to UK regulations, and give your players a flawless user experience.

Session Initiation and Session Control

The process begins with starting a player session. Your server invokes the `/game/init` endpoint with the player’s ID and their preferred bet settings. The API sends back a unique `session_token` and a URL for the game itself. You utilise that token for every following action in that specific game round.

The session system handles timeouts, dropouts, and games left hanging. The API includes a resume function. If a player gets disconnected, they can return to the same game within a set time. This ensures equity and stops players getting annoyed. We record all session data, which you’ll want for UK compliance audits.

User and Money Settings

When you initialise a game, you need to transmit specific details to set it up right. The player’s locale (like `en-GB`) determines the language and how currency looks. The `currency_code` (for example, GBP) must be the same as the player’s wallet currency. The API validates the bet limits against both the game’s own rules and any extra limits you provide.

Going Live Checklist

Going live needs a last review. Update all your API calls from the staging URL to the production URL. Get your live API keys in place, stored securely. Perform a final end-to-end test with real money, even if it’s just a few pence (a «penny drop» test).

Ensure your callback URLs are live on the public internet, using HTTPS, and that your firewall accepts traffic from our production servers (we’ll give you the IP list). Double-check that your logging systems are recording all API calls and errors. Finally, inform your support team on how the game works and what to do if a player has a technical question.

Post-Launch Monitoring

Once the game is live, monitor it closely. Track the API response times, error rates, and whether transactions finish. We provide a status dashboard for our services. For help, UK developers can use a dedicated technical support line. Our SLAs specify our uptime promises and how fast we’ll respond if something breaks.

Staging and Development Environment

Don’t go straight to live. Start with our staging environment. This sandbox replicates the real API but operates with pretend money. No real cash changes hands. We’ll give you separate staging API keys so you can test the whole player journey, testing wins, losses, and edge scenarios.

In staging, you can force specific game events. You can trigger a bonus round or a jackpot to see how your platform reacts. This is the ideal way to test your handling of game states and financial tracking. We supply full test scripts and a simulator dashboard to all UK partners.

UKGC Compliance Testing

The staging tools let you test UK compliance features. You can simulate our reality check prompts and time-out functions. You can also ensure that game history and transaction logs are stored properly for regulatory reports. This step guarantees your live setup will pass UKGC scrutiny.

Overview to the Balloon Boom Slot API

The Balloon Boom Slot API acts as a RESTful API for server-to-server talk. It allows your site manage game play sessions, process money payment actions, and fetch game results reliably. It’s constructed to manage the busy traffic of the UK market. Setting it up is simple, so you can launch the game rapidly without losing control on the player journey or your own backend systems.

The API functions on a few solid ideas. Critical API calls are safe to repeat, so repeating them are harmless. Error management is straightforward, and the stateless architecture keeps things reliable, even during network interruptions. Every API request requires an API key for authentication, and all sensitive information gets encrypted. This meets the security requirements the UK Gambling Commission demands.

Money Operations: Gambling and Payouts

The main money loop is simple: make a bet, get a result. You call the `/bet` endpoint with the `session_token` and the exact wager amount. The API verifies the bet, removes the money from the player’s credit (which you manage), and spins the reels. The response arrives with the full result, containing any win.

Wins are added to the player’s balance on your system right away. This happens either through a callback or straight in the response, based on how you set it up. The API offers you a full win breakdown: the multiplier, the winning lines, and the total. Every single transaction carries its own ID so you can reconcile everything up later.

  • Bet Placement: Call `/bet` with the token and amount. Check the player has enough money first.
  • Result Processing: The API transmits back the game outcome and any win amount in one step.
  • Balance Update: Your platform updates the player’s cash balance instantly. Use the net change (win minus bet).
  • Transaction Logging: Save the transaction ID, bet amount, win amount, and net change in your own records.

Callback endpoints and Webhook Setup

You must configure callback URLs (webhooks) on your server for background updates and enhanced security. The key one is for balance updates. It gives you a additional verification of any money transaction. Our API will POST a signed payload to your endpoint, and you must answer with a 200 OK.

Other webhooks can inform you about promotion triggers, session closures, or system alerts. Your callback endpoint must be reliable, fast, and must validate the signature on every incoming request. If you fail to reply, game processes could stall and the player will notice.

Error Processing and Status Codes

The API utilizes standard HTTP status codes. A `200 OK` means success. `4xx` codes mean you submitted something incorrect, like bad data or a bet with no funds. `5xx` codes indicate something went wrong on our server. Every error response has a code for your systems and a message for your developers.

You’ll see errors for invalid API keys (`401 Unauthorized`), bets on dead sessions (`410 Gone`), or our server being down (`503 Service Unavailable`). Your code ought to handle these cleanly, telling the user something’s up without giving away technical secrets. For `5xx` errors, it’s wise to retry the request with a waiting period that gets longer each time.

API Security and Security

You require a specific API key to invoke the Balloon Boom Slot API. We issue you this key when you start. Put it in the header of every HTTP request you make. For money transactions, like moving funds, the API also uses HMAC request signing. This extra step ensures nothing gets changed on the way.

Safe Communication Protocols

You must connect using TLS 1.2 or a newer version. The API supports perfect forward secrecy. Your role is to hold those API keys private and change them now and then. This is a fundamental part of managing a secure service in the UK.

Signature Generation Methodology

For the financial endpoints, you create a signature with a shared secret. The signature hashes together the request timestamp, a nonce, and the full request body. Our server checks this signature to verify the request is real and unaltered. We reject any request with a timestamp older than five minutes, which prevents replay attacks.

Game Attributes and Special Rounds

Balloon Boom Slot offers additional features such as free spins, bonus features, and cascading reels. The API controls the entire logic for these. If a bonus round begins, the API response includes a `feature_type` flag and all information the game client requires to display it correctly.

For engaging bonus games, the API monitors the condition. Your system just forwards the player’s decisions back, and the API calculates the prizes. This approach places the intricate game logic on our safe servers. It makes your implementation simpler and ensures the game operates as intended.

Managing Tumbling Victories and Bonus Spins

With tumbling reels, one bet can produce multiple wins in a row. The API combines these into a single `bet` response to reduce latency. The response contains an array called `cascade_steps`. Each step details the win for that cascade. Sum them to calculate the total win, and credit the user’s balance with that total amount.

Last Steps

This documentation covers what you need to set up the Balloon Boom Slot for your UK players. Adhere to the authentication, session, and money protocols described here to establish a secure and fair game experience. Checking thoroughly in the staging sandbox and completing the production checklist are your last tasks before a solid, reliable launch.