UK developers and providers who want to add the Book of Dead slot to their platforms need reliable API documentation to begin. This guide describes the Book of Dead slot API. It details the endpoints, data types, and how to set it up, all with the UK’s regulated market in mind. You’ll find out about authentication, simulating spins, and controlling the game’s famous Expanding Symbol mechanic. The aim is a trustworthy, legally sound implementation.
Grasping the Book of Dead API Structure
The Book of Dead slot API is a web service that uses JSON for transmitting and receiving data. Developed for high uptime, it maintains players involved even during busy periods like major football matches. The layout separates the game logic server from the client-side display. This separation guarantees that outcomes, like reel stops and bonus triggers, are unpredictable and processed securely on the backend.
In a standard setup, your platform is the client. It starts sessions and sends player actions. An API gateway accepts these requests and directs them to the correct game service. For UK operators, this framework enables the audit trails and data isolation the Gambling Commission requires. Comprehending this process assists with debugging and adding custom features like tournaments or special promotions.
The API is stateless. Every request must include its own authentication and context. This method aids scalability and dependability, allowing the service to cope with traffic spikes. To keep things seamless for users, even with network issues, you should include retry logic and connection pooling on your end.
Verification and Secure Session Setup
Security comes first. The Book of Dead API uses OAuth 2.0 client credentials for authentication. You must have a unique `client_id` and `client_secret` from the provider. All transmission happens over HTTPS, with a bearer token placed in the `Authorization` header. Since this token expires, your code must update it automatically to avoid disrupting a player’s session.
To begin a game session, send a POST request to `/session/start`. The payload needs the player’s unique ID (linked to your system), their currency (GBP), and language setting. For UK compliance, you must also include the player’s current session ID from your responsible gambling tools. This enables the game connect with timeout and limit functions. The response provides you a `game_session_token` for all further requests.
We use strict IP whitelisting for server-to-server calls from https://en.wikipedia.org/wiki/Main_Page UK operators. Also, every spin and financial transaction gets a digital signature. Your integration must validate these signatures with our public key to confirm data hasn’t been changed. This step is essential for legal UK operation and secures both you and the player from interference.
Key Gameplay Endpoints: Spin and Payout
The primary endpoint for play is `/game/spin`. A POST request to this endpoint triggers a single spin at the player’s selected stake. The request should include the `game_session_token`, the `stake` in GBP, and an optional `feature_buy` flag if you offer that. Your system needs to verify the player has sufficient funds before calling the API, because the API does not manage wallet balances.
The spin response is a detailed JSON object. It holds a `reel_stops` array indicating each reel’s position and a `symbols_matrix` for your client to animate. The `winning_lines` array details any payline wins, specifying the line number, symbol, and payout. Importantly, it tells you if the Free Spins bonus round was triggered, which happens when three or more Book scatter symbols show up anywhere.
For the UK market, the response contains required compliance fields. These comprise a `spin_timestamp` in UTC, a distinct `round_id` for audits, and the `total_payout`. You need to store this data permanently for UKGC reporting and any customer disputes. A best practice is to log it in real-time as soon as you receive the response, so nothing is lost.
Managing the Free Spins Reward and Growing Symbol
When the Free Spins bonus activates, a distinct sequence commences. The original base game spin response signals the activation. Your client then requests `/bonus/initiate` with the `round_id` from that spin. This provides the bonus data: how many free spins were given and, most significantly, the randomly picked `expanding_symbol` for this round.
The Expanding Symbol is what turns Book of Dead thrilling. During free spins, one regular symbol turns into an expanding wild. If this symbol lands, it stretches to fill the whole reel, generating bigger wins. The API answer for each free spin plainly states if an expansion happened and the win factor that followed. Your visual should display this spread clearly to match the game’s design and what players expect.
You perform each free spin with a command to `/bonus/spin`. The sequence goes on until all granted spins are consumed. The API tracks the bonus round status, so you only require to transmit the `bonus_round_id`. Wins accumulate, and the total is granted at the finish. Your user screen should show the number of free spins remaining and the active expanding symbol, maintaining the player updated.
Transaction Integration and Transaction Reporting
Accuracy of finances is crucial. The Book of Dead API does not touch real money. It only determines win amounts. Your platform must remove the stake before calling the spin endpoint, then credit the winnings after you obtain and confirm the result. This demands solid, atomic transaction logic on your backend to avoid race conditions or balance errors.
All money values in the API are in GBP, with two decimal places. The `payout` value in the response is the net win for that spin (the total win minus the stake). You credit this amount to the player’s balance. UK operators also need to record `total_stake` and `total_wins` per player session to work out Gross Gambling Yield for regulatory reports.
We offer a `/transactions/history` endpoint for reconciliation. You can query it with a date range or a specific `round_id` to obtain a signed record of all transactions. UK licensees typically perform a daily reconciliation with this data. It ensures that your financial records match with the provider’s logs, creating a clear audit trail.
Error Management and Regulation for the UK Market
Good error handling maintains stability. The API employs standard HTTP status codes along with a specific `error_code` and `message` in the response body. Common errors consist of `INSUFFICIENT_BALANCE` (which you should catch before the request), `SESSION_EXPIRED`, and `BET_LIMIT_EXCEEDED`. Your code must handle these gracefully, perhaps by sending the player to a deposit page or explaining a limit breach, following UK responsible gambling rules.
UK-specific compliance errors require attention. If a player’s self-exclusion or timeout occurs during a game, experience slot book of dead, the API might respond with a `PLAYER_SUSPENDED` error. Your integration must halt the game session right away and move the player to a protected, non-gambling part of your site. Recording these events for your compliance team is required. The same goes for age verification failures; gameplay must stop immediately.
Implement using a circuit breaker pattern for API calls. If you encounter several timeouts or server errors (5xx statuses) in a row, your system should stop trying and handle failure smoothly, maybe presenting a maintenance message. This boosts the user experience and prevents your servers from overloading. Set up monitoring to alert your tech team if 4xx or 5xx error rates rise, so they can diagnose quickly.
Trialing and Modeling in a Sandbox Environment
Never go live without extensive testing in the sandbox. This environment mirrors the live API but uses test money and has no effect on real finances. You’ll get sandbox-only `client_id` and `client_secret` credentials. It allows you to simulate the whole player experience, from signing up and depositing to playing and withdrawing, so you can resolve any edge cases.
UK developers should concentrate on key test scenarios. Model the bonus round trigger often to check the Expanding Symbol animation works. Test large wins to confirm your balance updates and any manual review processes work. You must also test how your integration works with responsible gambling tools, like sending a timeout signal to verify gameplay stops properly. This is a compliance requirement.
The sandbox also includes tools to force specific outcomes, like activating a bonus or a losing spin. This is extremely useful for building and testing features like game history logs, bonus buy options, and your own promotional messages. Build a comprehensive automated test suite for these scenarios. Run it consistently, especially before you update your platform or when a new API version is released.