Book of Dead Game API Documentation for UK Developers

UK engineers and providers who want to add the Book of Dead slot to their platforms need solid API documentation to begin https://slotbookof.com/dead/. This guide covers the Book of Dead slot API. It outlines the interfaces, data types, and how to set it up, all with the UK’s regulated market in mind. You’ll discover about authorization, testing spins, and managing the game’s well-known Expanding Symbol feature. The objective is a reliable, legally valid setup.

Understanding the Book of Dead API Design

The Book of Dead slot API is a web service that uses JSON for transmitting and receiving data. Developed for high reliability, it holds players engaged even during busy periods like major football matches. The layout splits the game logic server from the client-side display. This split guarantees that results, like reel stops and bonus triggers, are random and handled securely on the backend.

In a typical setup, your platform is the client. It initiates sessions and sends player actions. An API gateway receives these requests and directs them to the right game service. For UK operators, this structure facilitates the audit trails and data isolation the Gambling Commission demands. Comprehending this sequence helps with debugging and adding custom features like tournaments or special promotions.

The API is stateless. Every request must contain its own authentication and context. This method supports scalability and stability, allowing the service to handle traffic spikes. To maintain things smooth for users, even with network issues, you should include retry logic and connection pooling on your end.

Authentication and Protected Session Setup

Protection comes first. The Book of Dead API uses OAuth 2.0 client credentials for authentication. You need 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 becomes invalid, your code must update it automatically to avoid breaking a player’s session.

To initiate a game session, send a POST request to `/session/start`. The payload requires the player’s unique ID (linked to your system), their currency (GBP), and language configuration. For UK compliance, you must also include the player’s current session ID from your responsible gambling tools. This allows the game link with timeout and limit features. The response gives you a `game_session_token` for all further communications.

We use strict IP whitelisting for server-to-server calls from 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 modified. This step is essential for legal UK operation and secures both you and the player from tampering.

Main Gameplay Endpoints: Spin and Result

The primary endpoint for play is `/game/spin`. A POST request to this endpoint executes a single spin at the player’s selected stake. The request needs to include the `game_session_token`, the `stake` in GBP, and an optional `feature_buy` flag if that is available. Your system needs to verify the player has enough funds before calling the API, since the API does not handle wallet balances.

The spin response returns a detailed JSON object. It holds a `reel_stops` array showing each reel’s position and a `symbols_matrix` for your client to display. The `winning_lines` array lists any payline wins, specifying the line number, symbol, and payout. Crucially, it tells you if the Free Spins bonus round started, which takes place when three or more Book scatter symbols show up anywhere.

For the UK market, the response includes required compliance fields. These comprise a `spin_timestamp` in UTC, a specific `round_id` for audits, and the `total_payout`. You must store this data permanently for UKGC reporting and any customer disputes. A good practice is to log it in real-time as soon as you receive the response, so nothing gets lost.

Processing the Free Spin Bonus and Growing Icon

When the Free Spins bonus starts, a separate sequence commences. The initial base game spin reply indicates the trigger. Your client then sends `/bonus/initiate` with the `round_id` from that spin. This provides the bonus data: how many free spins were awarded and, most crucially, the randomly chosen `expanding_symbol` for this round.

The Expanding Symbol is what turns Book of Dead thrilling. During free spins, one normal symbol turns into an expanding wild. If this symbol lands, it stretches to fill the entire reel, creating bigger wins. The API answer for each free spin explicitly says if an enlargement happened and the win rate that resulted. Your graphic should demonstrate this expansion vividly to match the game’s design and what players look for.

You execute each free spin with a command to `/bonus/spin`. The sequence goes on until all given spins are used up. The API tracks the bonus round condition, so you only need to send the `bonus_round_id`. Wins accumulate, and the sum is granted at the end. Your user screen should display the number of free spins available and the live expanding symbol, maintaining the player aware.

Financial Integration and Financial Reporting

Precision in finances is essential. The Book of Dead API does not handle real money. It only determines win amounts. Your platform must remove the stake before triggering the spin endpoint, then credit the winnings after you obtain and confirm the result. This needs robust, 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 record `total_stake` and `total_wins` per player session to calculate Gross Gambling Yield for regulatory reports.

We provide a `/transactions/history` endpoint for reconciliation. You can request it with a date range or a specific `round_id` to obtain a signed record of all transactions. UK licensees typically run a daily reconciliation with this data. It verifies that your financial records align with the provider’s logs, creating a clear audit trail.

Error Handling and Regulatory Compliance for the UK Market

Good error handling ensures stability. The API employs standard HTTP status codes along with a specific `error_code` and `message` in the response body. Common errors are `INSUFFICIENT_BALANCE` (which you should catch before the request), `SESSION_EXPIRED`, and `BET_LIMIT_EXCEEDED`. Your code must process these gracefully, perhaps by sending the player to a deposit page or clarifying 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, the API might respond with a `PLAYER_SUSPENDED` error. Your integration must terminate the game session right away and move the player to a protected, non-gambling part of your site. Logging these events for your compliance team is compulsory. The same applies for age verification failures; gameplay must cease immediately.

Consider using a circuit breaker pattern for API calls. If you encounter several timeouts or server errors (5xx statuses) in a row, your system should cease attempts and fail gracefully, maybe displaying a maintenance message. This improves the user experience and prevents your servers from overloading. Set up monitoring to warn your tech team if 4xx or 5xx error rates climb, so they can diagnose quickly.

Testing and Modeling in a Isolated Environment

Never go live without extensive testing in the sandbox. This environment emulates 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 lets you 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 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 highly 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 frequently, especially before you update your platform or when a new API version is released.