Book of Dead Slot API Documentation for UK Developers

UK developers and providers who want to add the Book of Dead slot to their sites need comprehensive API documentation to begin https://slotbookof.com/dead/. This guide explains the Book of Dead slot API. It details the endpoints, data structures, and how to configure it, all with the UK’s regulated market in mind. You’ll learn about authentication, running spins, and controlling the game’s iconic Expanding Symbol feature. The aim is a dependable, 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 sending and accepting data. Built for high reliability, it holds players engaged even during busy periods like major football matches. The design divides the game logic server from the client-side display. This split assures that findings, like reel stops and bonus triggers, are random and handled securely on the backend.

In a common setup, your platform is the client. It starts sessions and transmits player actions. An API gateway receives these requests and directs them to the right game service. For UK operators, this framework facilitates the audit trails and data isolation the Gambling Commission requires. Grasping this flow helps with debugging and incorporating custom features like tournaments or special promotions.

The API is stateless. Every request must carry its own authentication and context. This strategy supports scalability and reliability, allowing the service to cope with traffic spikes. To maintain things seamless for users, even with network hiccups, you should add retry logic and connection pooling on your end.

Authentication and Safe Session Setup

Security comes first. The Book of Dead API uses OAuth 2.0 client credentials for authorisation. 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 becomes invalid, your code must refresh 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 configuration. For UK compliance, you must also include the player’s current session ID from your responsible gambling tools. This lets the game connect with timeout and limit functions. The response provides you a `game_session_token` for all further calls.

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 verify these signatures with our public key to ensure data hasn’t been modified. This step is essential for legal UK operation and protects both you and the player from tampering.

Core Gameplay Endpoints: Spin and Payout

The key endpoint for play is `/game/spin`. A POST request to this endpoint places 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 provide that. Your system needs to verify the player has sufficient funds before calling the API, as the API does not process wallet balances.

The spin response returns a detailed JSON object. It holds a `reel_stops` array displaying each reel’s position and a `symbols_matrix` for your client to render. The `winning_lines` array details 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 includes required compliance fields. These comprise a `spin_timestamp` in UTC, a unique `round_id` for audits, and the `total_payout`. You are required to store this data for the long term for UKGC reporting and any customer disputes. A best practice is to log it in real-time as soon as you obtain the response, so nothing gets lost.

Processing the Free Spin Feature and Expanding Sign

When the Free Spins bonus activates, a different sequence begins. The initial base game spin response indicates the start. Your client then calls `/bonus/initiate` with the `round_id` from that spin. This returns the bonus details: how many free spins were awarded and, most crucially, the randomly selected `expanding_symbol` for this round.

The Expanding Symbol is what renders Book of Dead engaging. During free spins, one normal symbol turns into an expanding wild. If this symbol hits, it extends to fill the full reel, generating bigger wins. The API response for each free spin plainly says if an spread occurred and the win factor that ensued. Your visual should display this spread clearly to align with the game’s design and what players look for.

You carry out each free spin with a request to `/bonus/spin`. The series proceeds until all given spins are consumed. The API monitors the bonus round state, so you only need to submit the `bonus_round_id`. Wins build up, and the total is granted at the finish. Your user display should show the count of free spins available and the active expanding symbol, keeping the player updated.

Transaction Integration and Reporting of Transactions

Precision in finances is essential. The Book of Dead API does not handle real money. It only calculates win amounts. Your platform must deduct the stake before calling the spin endpoint, then add the winnings after you get and verify the result. This requires strong, 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 monitor `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 conduct 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 Processing and Regulation for the UK Market

Proper error handling ensures stability. 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 catch before the request), `SESSION_EXPIRED`, and `BET_LIMIT_EXCEEDED`. Your code must handle these seamlessly, perhaps by directing 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 return a `PLAYER_SUSPENDED` error. Your integration must terminate the game session right away and move the player to a secure, non-gambling part of your site. Recording these events for your compliance team is compulsory. The same holds true for age verification failures; gameplay must stop immediately.

Think about 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 handle failure smoothly, maybe presenting a maintenance message. This boosts the user experience and prevents your servers from overloading. Set up monitoring to notify your tech team if 4xx or 5xx error rates climb, so they can look into quickly.

Simulation and Testing in a Test Environment

Never go live without extensive 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 enables 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. Simulate 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 initiating 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 frequently, especially before you update your platform or when a new API version is released.