This manual provides UK engineers and platforms the specifications required to integrate the Balloon Boom Slot game. You’ll see the API connections, data formats, and setup options here. By following these steps allows you to deploy the game to your iGaming website, keep within UK regulations, and offer your users a smooth gaming experience.
Game Attributes and Special Rounds
Balloon Boom Slot has extra features like free spins, bonus games, and cascading reels. The API manages all functions for these. If a feature round starts, the API response will contain a `feature_type` indicator and all the data the game client needs to render it properly.
For interactive bonus rounds, the API tracks the status. Your backend just forwards the user’s choices back, and the API works out the rewards. This design places the complex game logic on our protected servers. It makes your implementation easier and guarantees the game works as designed.
Managing Cascading Wins and Bonus Spins
With cascading reels, one bet can result in several wins in succession. The API combines these into a single `bet` response to reduce latency. The response has an array named `cascade_steps`. Each step specifies the win for that cascade. Add them all up to get the overall win, and adjust the user’s balance with that final sum.
Introduction to the Balloon Boom Slot API
The Balloon Boom Slot API is a RESTful interface for server-to-server talk. It enables your system administer game play sessions, manage money payment actions, and retrieve game results reliably. It’s constructed to cope with the high traffic of the UK gaming market. Installation is straightforward, allowing you to launch the game rapidly without losing control on the user flow or your own backend systems.
The API functions built on a few key concepts. Key requests are idempotent, so repeated requests are harmless. Error management is clear, and the stateless approach maintains dependability, even during network interruptions. Every API request demands an API key for authentication, and all sensitive data gets encrypted. This matches the security compliance the UK Gambling Commission requires.
Money Operations: Gambling and Winnings
The main money loop is straightforward: put a bet, obtain a result. You invoke the `/bet` endpoint with the `session_token` and the exact wager amount. The API verifies the bet, deducts the money from the player’s credit (which you manage), and spins the reels. The response arrives with the full result, including any win.
Wins are applied to the player’s balance on your system right away https://balloonboom.net/. This occurs either through a callback or immediately in the response, according to how you connected. The API provides you a full win breakdown: the multiplier, the winning lines, and the total. Every single transaction possesses its own ID so you can reconcile everything up later.
- Bet Placement: Invoke `/bet` with the token and amount. Verify the player has enough money first.
- Result Processing: The API sends 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: Store the transaction ID, bet amount, win amount, and net change in your own records.
Callback URLs and Webhook Setup
You must configure callback URLs (webhooks) on your server for async updates and additional security. The critical one is for balance notifications. It offers you a secondary confirmation of any money transaction. Our API will POST a signed payload to your endpoint, and you must reply with a 200 OK.
Other webhooks can inform you about promotional triggers, session terminations, or system notifications. Your callback endpoint must be dependable, quick, and must verify the signature on every incoming payload. If you don’t answer, game processes may stall and the player will notice.
Error Processing and Response Codes
The API utilizes standard HTTP status codes. A `200 OK` indicates success. `4xx` codes indicate you sent something invalid, like bad data or a bet with no funds. `5xx` codes signal something went wrong on our server. Every error response has a code for your systems and a message for your developers.
You’ll find errors for invalid API keys (`401 Unauthorized`), bets on dead sessions (`410 Gone`), or our server being down (`503 Service Unavailable`). Your code should handle these cleanly, informing the user something’s up without revealing technical secrets. For `5xx` errors, it’s wise to retry the request with a waiting period that gets longer each time.
Session Initiation and Session Handling
The process begins with initiating a player session. Your server requests the `/game/init` endpoint with the player’s ID and their chosen bet settings. The API sends back a unique `session_token` and a URL for the game itself. You employ that token for every following action in that specific game round.
The session system handles timeouts, dropouts, and games left hanging. The API has a resume function. If a player gets disconnected, they can return to the same game within a set time. This maintains fairness and prevents players getting annoyed. We record all session data, which you’ll want for UK compliance audits.
Gambler and Currency Configuration
When you initialise a game, you need to provide specific details to configure it correctly. The player’s locale (like `en-GB`) controls 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 each of the game’s own rules and any extra limits you send.
Launching Checklist
Going live needs a thorough verification. Update all your API calls from the staging URL to the production URL. Obtain your live API keys in place, stored securely. Conduct a final end-to-end test with real money, even if it’s just a few pence (a “penny drop” test).
Verify 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). Reconfirm that your logging systems are recording all API calls and errors. To finish, inform your support team on how the game works and what to do if a player has a technical question.
Launch Follow-Up
Once the game is live, watch it carefully. Track the API response times, error rates, and whether transactions complete. We have 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.
Last Steps
This documentation includes what you need to implement 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 strong, reliable launch.
API Security and Protection
You must have a unique API key to call the Balloon Boom Slot API. We issue you this key when you get started. Place it in the header of every HTTP request you submit. For money transactions, like moving funds, the API also utilizes HMAC request signing. This extra step ensures nothing gets altered on the way.
Secure Communication Protocols
You must connect using TLS 1.2 or a later version. The API supports perfect forward secrecy. Your task is to maintain those API keys confidential and change them now and then. This is a core part of managing a secure service in the UK.
Request Signing Methodology
For the financial endpoints, you build a signature with a shared secret. The signature encodes together the request timestamp, a nonce, and the full request body. Our server checks this signature to ensure the request is genuine and unaltered. We deny any request with a timestamp older than five minutes, which stops replay attacks.
Testing and Staging Environment
Skip the live environment. Use our staging environment first. This sandbox copies the real API but uses pretend money. Real funds are not used. We’ll give you separate staging API keys so you can test the whole player journey, verifying wins, losses, and edge scenarios.
In staging, you can force specific game events. You can activate a bonus round or a jackpot to check how your platform responds. This is the best way to test your handling of game states and financial tracking. We offer full test scripts and a simulator dashboard to all UK partners.
UKGC Compliance Testing
The staging tools let you verify UK compliance features. You can test our reality check prompts and time-out functions. You can also confirm that game history and transaction logs are logged properly for regulatory reports. This step makes sure your live setup will pass UKGC scrutiny.