UK developers and operators who want to include the Book of Dead slot to their sites need solid API documentation to commence. This guide describes the Book of Dead slot API. It outlines the endpoints, data structures, and how to configure it, all with the UK’s regulated market in mind. You’ll find out about verification, running spins, and managing the game’s well-known Expanding Symbol function. The objective is a reliable, legally valid integration.
Understanding the Book of Dead API Architecture
The Book of Dead slot API is a REST-based service that uses JSON for transmitting and receiving data. Designed for high uptime, it maintains players entertained even during peak periods like major football matches. The architecture divides the game logic server from the client-side display. This division guarantees that results, like reel stops and bonus triggers, are arbitrary and handled securely on the backend.
In a common setup, your platform is the client. It begins sessions and transmits player actions. An API gateway accepts these requests and directs them to the right game service. For UK operators, this system facilitates the audit trails and data isolation the Gambling Commission demands. Comprehending this sequence aids with debugging and introducing custom features like tournaments or special promotions.
The API is stateless. Every request must include its own authentication and context. This strategy supports scalability and dependability, allowing the service to handle traffic spikes. To keep things smooth for users, even with network problems, you should add retry logic and connection pooling on your end.
Verification and Protected 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 communication happens over HTTPS, with a bearer token placed in the `Authorization` header. Since this token expires, your code must renew it automatically to avoid breaking a player’s session.
To start 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 capabilities. The response returns you a `game_session_token` for all further calls.
We use strict IP whitelisting for server-to-server calls from UK operators https://slotbookof.com/dead/. Also, every spin and financial transaction gets a digital signature. Your integration must verify these signatures with our public key to ensure data hasn’t been modified. This step is crucial for legal UK operation and protects both you and the player from alteration.
Core Gameplay Endpoints: Spin and Result
The key endpoint for play is `/game/spin`. A POST request to this endpoint executes a single spin at the player’s chosen stake. The request needs to include the `game_session_token`, the `stake` in GBP, and an elective `feature_buy` flag if that is available. Your system needs to verify the player has adequate funds before calling the API, because the API does not process wallet balances.
The spin response returns a detailed JSON object. It holds a `reel_stops` array indicating each reel’s position and a `symbols_matrix` for your client to render. The `winning_lines` array lists any payline wins, showing the line number, symbol, and payout. Crucially, it tells you if the Free Spins bonus round began, which occurs when three or more Book scatter symbols appear anywhere.
For the UK market, the response features required compliance fields. These include a `spin_timestamp` in UTC, a specific `round_id` for audits, and the `total_payout`. You are required to store this data indefinitely for UKGC reporting and any customer disputes. A good practice is to log it in real-time as soon as you obtain the response, so nothing is lost.
Handling the Free Spins Bonus and Expanding Sign
When the Free Spins bonus triggers, a distinct process commences. The first base game spin response marks the start. Your client then requests `/bonus/initiate` with the `round_id` from that spin. This provides the bonus information: how many free spins were given and, most importantly, the randomly chosen `expanding_symbol` for this session.
The Expanding Symbol is what turns Book of Dead thrilling. During free spins, one normal symbol converts into an expanding wild. If this symbol hits, it stretches to fill the full reel, producing bigger wins. The API answer for each free spin plainly says if an expansion took place and the win multiplier that ensued. Your graphic should display this spread clearly to align with the game’s layout and what players look for.
You perform each free spin with a call to `/bonus/spin`. The run proceeds until all given spins are used up. The API monitors the bonus round condition, so you only have to submit the `bonus_round_id`. Wins accumulate, and the aggregate is awarded at the end. Your user display should display the number of free spins left and the active expanding symbol, keeping the player aware.
Financial Integration and Transaction Reporting
Accuracy of finances is essential. The Book of Dead API does not process real money. It only computes win amounts. Your platform must remove the stake before invoking the spin endpoint, then apply the winnings after you receive and validate 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 deposit this amount to the player’s balance. UK operators also need to track `total_stake` and `total_wins` per player session to determine Gross Gambling Yield for regulatory reports.
We provide a `/transactions/history` endpoint for reconciliation. You can query it with a date range or a specific `round_id` to retrieve a signed record of all transactions. UK licensees typically run a daily reconciliation with this data. It checks that your financial records line up with the provider’s logs, creating a clear audit trail.
Error Handling and Compliance for the UK Market
Effective error handling keeps things stable. The API utilizes standard HTTP status codes along with a specific `error_code` and `message` in the response body. Common errors include `INSUFFICIENT_BALANCE` (which you should trap before the request), `SESSION_EXPIRED`, and `BET_LIMIT_EXCEEDED`. Your code must handle these smoothly, perhaps by sending the player to a deposit page or describing a limit breach, following UK responsible gambling rules.
UK-specific compliance errors require attention. If a player’s self-exclusion or timeout activates during a game, the API might return a `PLAYER_SUSPENDED` error. Your integration must stop the game session right away and move the player to a safe, non-gambling part of your site. Recording these events for your compliance team is compulsory. The same goes for age verification failures; gameplay must cease immediately.
Consider using a circuit breaker pattern for API calls. If you experience several timeouts or server errors (5xx statuses) in a row, your system should stop trying and fail gracefully, maybe presenting a maintenance message. This boosts the user experience and avoids your servers from overloading. Configure monitoring to alert your tech team if 4xx or 5xx error rates climb, so they can investigate quickly.
Testing and Simulation in a Test Environment
Never go live without comprehensive testing in the sandbox. This environment mirrors the live API but uses test money and doesn’t affect real finances. You’ll get sandbox-only `client_id` and `client_secret` credentials. It lets you simulate the whole player experience, from signing up and depositing to playing and withdrawing, so you can fix any edge cases.
UK developers should focus 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 operate. 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 legal requirement.
The sandbox also includes tools to force specific outcomes, like triggering 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 regularly, especially before you update your platform or when a new API version is released.