Book of Dead Game API Documentation for UK Developers

UK engineers and platforms who want to add the Book of Dead slot to their sites need comprehensive API documentation to start. This guide describes the Book of Dead slot API. It details the routes, data structures, and how to configure it, all with the UK’s regulated market in mind. You’ll learn about authentication, simulating spins, and managing the game’s iconic Expanding Symbol function. The objective is a reliable, legally compliant setup.

Understanding the Book of Dead API Design

The Book of Dead slot API is a web service that uses JSON for exchanging and receiving data. Designed for high reliability, it keeps players engaged even during peak periods like major football matches. The architecture divides the game logic server from the client-side display. This split ensures that results, like reel stops and bonus triggers, are unpredictable and processed securely on the backend.

In a typical implementation, your platform is the client. It begins sessions and forwards player actions. An API gateway accepts these requests and directs them to the correct game service. For UK operators, this system supports the audit trails and data separation the Gambling Commission demands. Comprehending this process assists 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 approach aids scalability and dependability, allowing the service to manage traffic spikes. To keep things seamless for users, even with network hiccups, you should include retry logic and connection pooling on your end.

Verification and Safe Session Start

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

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 confirm data hasn’t been modified. This step is vital for legal UK operation and secures both you and the player from interference.

Core Gameplay Endpoints: Spin and Outcome

The key endpoint for play is `/game/spin`. A POST request here places a single spin at the player’s selected 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, as the API does not process 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 details any payline wins, specifying the line number, symbol, and payout. Critically, it informs you if the Free Spins bonus round started, which happens when three or more Book scatter symbols land anywhere.

For the UK market, the response features required compliance fields. These comprise a `spin_timestamp` in UTC, a specific `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 immediately as soon as you get the response, so nothing goes missing.

Handling the Free Spin Feature and Expanding Icon

When the Free Spins round activates, a distinct sequence starts. The original base game spin result marks the activation. Your client then calls `/bonus/initiate` with the `round_id` from that spin. This gives the bonus information: how many free spins were awarded and, most significantly, the randomly chosen `expanding_symbol` for this round.

The Expanding Symbol is what makes Book of Dead exciting. During free spins, one normal symbol converts into an expanding wild. If this symbol lands, it extends to fill the full reel, generating bigger wins. The API response for each free spin clearly indicates if an enlargement happened and the win factor that ensued. Your animation should show this expansion vividly to match the game’s design and what players expect.

You perform each free spin with a command to `/bonus/spin`. The run goes on until all given spins are exhausted. The API tracks the bonus round condition, so you only require to send the `bonus_round_id`. Wins accumulate, and the aggregate is granted at the end. Your user interface should show the count of free spins left and the live expanding symbol, keeping the player updated.

Payment Integration and Financial Reporting

Precision in finances is critical. The Book of Dead API does not process real money. It only determines win amounts. Your platform must deduct the stake before calling the spin endpoint, then credit the winnings after you get and verify the result. This needs strong, atomic transaction logic on your backend to circumvent 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 allocate 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 conduct a daily reconciliation with this data. It ensures that your financial records align with the provider’s logs, creating a clear audit trail.

Error Handling and Regulation 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 handle 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 describing a limit breach, following UK responsible gambling rules.

UK-specific compliance errors demand attention. If a player’s self-exclusion or timeout triggers 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 mandatory. The same applies for age verification failures; gameplay must halt immediately.

Think about using a circuit breaker pattern for API calls. If you see 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 alert your tech team if 4xx or 5xx error rates rise, so they can investigate quickly.

Trialing and Testing in a Isolated Environment

Never go live without thorough testing in the sandbox. This environment emulates 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 allows you to simulate the whole player experience, from signing up and depositing to playing and withdrawing, so you can fix any edge cases.

UK developers should concentrate on key test scenarios https://slotbookof.com/dead/. 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 regulatory 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 complete automated test suite for these scenarios. Run it consistently, especially before you update your platform or when a new API version is released.