Book of Dead Game API Documentation for UK Developers

Blog

Book of Dead Game API Documentation for UK Developers

UK developers and providers who want to include the Book of Dead slot to their systems need comprehensive API documentation to start https://slotbookof.com/dead/. This guide describes the Book of Dead slot API. It walks through the endpoints, data formats, and how to set it up, all with the UK’s regulated market in mind. You’ll learn about authorization, simulating spins, and controlling the game’s famous Expanding Symbol feature. The goal is a dependable, legally compliant setup.

Grasping the Book of Dead API Architecture

The Book of Dead slot API is a RESTful service that uses JSON for exchanging and receiving data. Developed for high availability, it maintains players engaged even during busy periods like major football matches. The architecture splits the game logic server from the client-side display. This separation ensures that findings, like reel stops and bonus triggers, are unpredictable and processed securely on the backend.

In a typical integration, your platform is the client. It starts sessions and transmits player actions. An API gateway accepts 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 sequence assists 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 approach promotes scalability and stability, allowing the service to manage traffic spikes. To ensure things fluid for users, even with network issues, you should implement retry logic and connection pooling on your end.

Verification and Protected Session Start

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

To start 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 setting. 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 functions. The response returns 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 verify these signatures with our public key to ensure data hasn’t been altered. This step is vital for legal UK operation and secures both you and the player from alteration.

Core Gameplay Endpoints: Spin and Payout

The key endpoint for play is `/game/spin`. A POST request here executes a single spin at the player’s chosen stake. The request needs to include the `game_session_token`, the `stake` in GBP, and an non-mandatory `feature_buy` flag if that is available. Your system should confirm the player has adequate funds before calling the API, as the API does not manage 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 describes any payline wins, specifying the line number, symbol, and payout. Importantly, it indicates if the Free Spins bonus round started, which takes place when three or more Book scatter symbols land anywhere.

For the UK market, the response features required compliance fields. These include a `spin_timestamp` in UTC, a specific `round_id` for audits, and the `total_payout`. You need to store this data permanently for UKGC reporting and any customer disputes. A recommended approach is to log it immediately as soon as you get the response, so nothing gets lost.

Managing the Free Spins Feature and Expanding Icon

When the Free Spins feature activates, a distinct sequence starts. The initial base game spin response signals the start. Your client then requests `/bonus/initiate` with the `round_id` from that spin. This gives the bonus details: how many free spins were granted and, most importantly, the randomly chosen `expanding_symbol` for this round.

The Expanding Symbol is what turns Book of Dead engaging. During free spins, one regular symbol converts into an expanding wild. If this symbol appears, it expands to fill the full reel, producing bigger wins. The API response for each free spin clearly indicates if an enlargement occurred and the win factor that ensued. Your visual should demonstrate this enlargement vividly to align with the game’s style and what players expect.

You perform each free spin with a command to `/bonus/spin`. The run proceeds until all awarded spins are exhausted. The API keeps track of the bonus round state, so you only need to transmit the `bonus_round_id`. Wins add up, and the total is given at the end. Your user interface should present the number of free spins left and the current expanding symbol, keeping the player informed.

Financial Integration and Reporting of Transactions

Accuracy of finances is crucial. The Book of Dead API does not touch real money. It only determines win amounts. Your platform must subtract the stake before invoking the spin endpoint, then add the winnings after you obtain and validate the result. This demands solid, 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 request 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 checks that your financial records line up with the provider’s logs, creating a clear audit trail.

Error Processing and Regulatory Compliance for the UK Market

Good 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 catch before the request), `SESSION_EXPIRED`, and `BET_LIMIT_EXCEEDED`. Your code must manage these seamlessly, 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 triggers 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 protected, non-gambling part of your site. Logging these events for your compliance team is required. The same applies for age verification failures; gameplay must halt immediately.

Consider 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 handle failure smoothly, maybe presenting a maintenance message. This improves the user experience and prevents your servers from overloading. Establish monitoring to alert your tech team if 4xx or 5xx error rates rise, so they can diagnose quickly.

Trialing and Modeling in a Sandbox 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 address any edge cases.

UK developers should prioritize 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 regulatory requirement.

The sandbox also includes tools to force specific outcomes, like activating a bonus or a losing spin. This is very 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.

Leave your thought here

Your email address will not be published. Required fields are marked *

Donation Helps Us

$100
million goal