Book of Dead Game API Documentation for UK Developers

UK programmers and providers who want to integrate the Book of Dead slot to their systems need solid API documentation to commence https://slotbookof.com/dead/. This guide describes the Book of Dead slot API. It walks through the interfaces, data formats, and how to set it up, all with the UK’s regulated market in mind. You’ll discover about authentication, simulating spins, and controlling the game’s iconic Expanding Symbol feature. The goal is a reliable, legally valid implementation.

Comprehending the Book of Dead API Structure

The Book of Dead slot API is a RESTful service that uses JSON for sending and accepting data. Designed for high uptime, it holds players engaged even during peak periods like major football matches. The layout divides the game logic server from the client-side presentation. This division assures that results, like reel stops and bonus triggers, are random and processed securely on the backend.

In a common setup, your platform is the client. It begins sessions and transmits player actions. An API gateway receives these requests and routes them to the right game service. For UK operators, this system supports the audit trails and data separation the Gambling Commission demands. Comprehending this flow aids with debugging and adding 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 stability, allowing the service to handle traffic spikes. To keep things seamless for users, even with network issues, you should implement retry logic and connection pooling on your end.

Security and Safe Session Setup

Security 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 transmission happens over HTTPS, with a bearer token placed in the `Authorization` header. Since this token runs out, your code must update it automatically to avoid disrupting a player’s session.

To initiate a game session, send a POST request to `/session/start`. The payload must include 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 allows the game connect with timeout and limit functions. 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. 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 changed. This step is essential for legal UK operation and protects both you and the player from alteration.

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 non-mandatory `feature_buy` flag if you offer that. 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 comes as a detailed JSON object. It contains a `reel_stops` array indicating each reel’s position and a `symbols_matrix` for your client to animate. The `winning_lines` array lists any payline wins, specifying the line number, symbol, and payout. Critically, 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 contains required compliance fields. These are a `spin_timestamp` in UTC, a unique `round_id` for audits, and the `total_payout`. You must store this data indefinitely for UKGC reporting and any customer disputes. A best practice is to log it synchronously as soon as you get the response, so nothing goes missing.

Managing the Free Spins Bonus and Growing Sign

When the Free Spins feature activates, a different sequence starts. The first base game spin reply signals the trigger. Your client then requests `/bonus/initiate` with the `round_id` from that spin. This provides the bonus information: how many free spins were granted and, most crucially, the randomly chosen `expanding_symbol` for this game.

The Expanding Symbol is what makes Book of Dead exciting. During free spins, one regular symbol turns into an expanding wild. If this symbol appears, it stretches to fill the full reel, generating bigger wins. The API answer for each free spin explicitly states if an spread happened and the win multiplier that ensued. Your graphic should display this spread clearly to align with the game’s design and what players look for.

You perform each free spin with a command to `/bonus/spin`. The sequence continues until all granted spins are used up. The API keeps track of the bonus round status, so you only have to submit the `bonus_round_id`. Wins accumulate, and the aggregate is given at the end. Your user screen should present the quantity of free spins left and the live expanding symbol, keeping the player updated.

Financial Integration and Transaction Reporting

Financial accuracy is essential. The Book of Dead API does not process real money. It only calculates win amounts. Your platform must deduct the stake before invoking the spin endpoint, then add the winnings after you receive and verify the result. This demands solid, 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 deposit this amount to the player’s balance. UK operators also need to record `total_stake` and `total_wins` per player session to work out 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 ensures that your financial records align with the provider’s logs, building a clear audit trail.

Error Processing and Regulation for the UK Market

Proper 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 trap before the request), `SESSION_EXPIRED`, and `BET_LIMIT_EXCEEDED`. Your code must handle these seamlessly, 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 occurs during a game, the API might respond with a `PLAYER_SUSPENDED` error. Your integration must terminate the game session right away and redirect the player to a safe, non-gambling part of your site. Logging these events for your compliance team is mandatory. The same holds true for age verification failures; gameplay must halt immediately.

Implement using a circuit breaker pattern for API calls. If you experience several timeouts or server errors (5xx statuses) in a row, your system should back off and fail gracefully, maybe presenting a maintenance message. This enhances the user experience and prevents your servers from overloading. Set up monitoring to alert your tech team if 4xx or 5xx error rates increase, so they can look into quickly.

Trialing and Modeling in a Isolated Environment

Never go live without thorough 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 allows 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 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 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 compliance 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 thorough automated test suite for these scenarios. Run it consistently, especially before you update your platform or when a new API version is released.