Book of Dead Title API Documentation for UK Developers

UK programmers and providers who want to add the Book of Dead slot to their platforms need solid API documentation to begin. This guide describes the Book of Dead slot API. It outlines the routes, data structures, and how to configure it, all with the UK’s regulated market in mind. You’ll discover about authentication, running spins, and managing the game’s iconic Expanding Symbol feature. The objective is a dependable, legally compliant implementation.

Grasping the Book of Dead API Design

The Book of Dead slot API is a REST-based service that uses JSON for exchanging and fetching data. Developed for high availability, it keeps players involved even during busy periods like major football matches. The design divides the game logic server from the client-side presentation. This split guarantees that outcomes, like reel stops and bonus triggers, are random and managed securely on the backend.

In a standard implementation, your platform is the client. It begins sessions and sends player actions. An API gateway receives these requests and routes them to the correct game service. For UK operators, this structure facilitates the audit trails and data segregation the Gambling Commission demands. Grasping this process aids with debugging and incorporating custom features like tournaments or special promotions.

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

Authentication and Secure Session Initialisation

Security comes first. The Book of Dead API uses OAuth 2.0 client credentials for authentication. You require 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 renew it automatically to avoid disrupting a player’s session.

To begin a game session, send a POST request to `/session/start` https://slotbookof.com/dead/. The payload must include 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 enables 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 check 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 tampering.

Core Gameplay Endpoints: Spin and Outcome

The primary endpoint for play is `/game/spin`. A POST request here executes a single spin at the player’s picked 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 must check the player has enough funds before calling the API, because the API does not handle wallet balances.

The spin response comes as a detailed JSON object. It holds a `reel_stops` array showing each reel’s position and a `symbols_matrix` for your client to animate. The `winning_lines` array describes any payline wins, specifying the line number, symbol, and payout. Crucially, it informs you if the Free Spins bonus round was triggered, which occurs 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 distinct `round_id` for audits, and the `total_payout`. You must store this data for the long term for UKGC reporting and any customer disputes. A good practice is to log it immediately as soon as you get the response, so nothing is lost.

Processing the Bonus Spins Feature and Growing Symbol

When the Free Spins round triggers, a different sequence begins. The initial base game spin reply marks the trigger. Your client then calls `/bonus/initiate` with the `round_id` from that spin. This provides the bonus details: how many free spins were granted and, most crucially, the randomly chosen `expanding_symbol` for this session.

The Expanding Symbol is what makes Book of Dead exciting. During free spins, one standard symbol turns into an expanding wild. If this symbol appears, it extends to fill the full reel, producing bigger wins. The API response for each free spin explicitly states if an enlargement took place and the win rate that followed. Your graphic should demonstrate this expansion clearly to align with the game’s layout and what players look for.

You perform each free spin with a request to `/bonus/spin`. The run goes on until all granted spins are used up. The API keeps track of the bonus round condition, so you only have to transmit the `bonus_round_id`. Wins build up, and the sum is given at the finish. Your user screen should present the number of free spins remaining and the current expanding symbol, maintaining the player aware.

Transaction Integration and Transaction Reporting

Precision in finances is crucial. The Book of Dead API does not handle real money. It only determines win amounts. Your platform must remove the stake before invoking the spin endpoint, then apply the winnings after you get and confirm the result. This demands 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 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 conduct a daily reconciliation with this data. It verifies that your financial records align with the provider’s logs, creating a clear audit trail.

Error Management 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 are `INSUFFICIENT_BALANCE` (which you should handle 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 triggers during a game, the API might return a `PLAYER_SUSPENDED` error. Your integration must terminate the game session right away and redirect the player to a protected, 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 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 stop trying and degrade gracefully, maybe displaying a maintenance message. This improves the user experience and avoids your servers from overloading. Set up monitoring to alert your tech team if 4xx or 5xx error rates increase, so they can investigate quickly.

Trialing and Simulation in a Test Environment

Never go live without extensive testing in the sandbox. This environment mirrors the live API but uses test money and won’t impact 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 prioritize key test scenarios. Replicate 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 function. 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 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 complete automated test suite for these scenarios. Run it consistently, especially before you update your platform or when a new API version is released.