UK engineers and operators who want to integrate 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 details the endpoints, data types, and how to set it up, all with the UK’s regulated market in mind. You’ll learn about authorization, running spins, and controlling the game’s iconic Expanding Symbol function. The aim is a dependable, legally compliant implementation.
Understanding the Book of Dead API Structure
The Book of Dead slot API is a web service that uses JSON for sending and fetching data. Built for high uptime, it maintains players involved even during peak periods like major football matches. The architecture divides the game logic server from the client-side interface. This division ensures that findings, like reel stops and bonus triggers, are arbitrary and managed securely on the backend.
In a standard setup, your platform is the client. It initiates sessions and sends player actions. An API gateway takes these requests and routes them to the correct game service. For UK operators, this structure facilitates the audit trails and data separation the Gambling Commission requires. Comprehending this sequence helps with debugging and adding custom features like tournaments or special promotions.
The API is stateless. Every request must include its own authentication and context. This strategy supports scalability and reliability, letting the service to manage traffic spikes. To ensure things smooth for users, even with network issues, you should add retry logic and connection pooling on your end.
Security and Secure Session Initialisation
Protection 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 exchange 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 disrupting a player’s session.
To begin 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 setting. 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 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 validate these signatures with our public key to confirm data hasn’t been changed. This step is vital for legal UK operation and secures both you and the player from tampering.
Key Gameplay Endpoints: Spin and Result
The key endpoint for play is `/game/spin`. A POST request here places 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 that is available. Your system needs to verify the player has sufficient funds before calling the API, because the API does not manage wallet balances.
The spin response returns a detailed JSON object. It holds a `reel_stops` array indicating each reel’s position and a `symbols_matrix` for your client to render. The `winning_lines` array lists any payline wins, listing the line number, symbol, and payout. Crucially, it tells 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 distinct `round_id` for audits, and the `total_payout`. You are required to store this data indefinitely for UKGC reporting and any customer disputes. A best practice is to log it immediately as soon as you receive the response, so nothing is lost.
Handling the Free Spins Bonus and Enlarging Symbol
When the Free Spins feature activates, a different series commences. The original base game spin reply marks the start. 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 importantly, the randomly selected `expanding_symbol` for this session.
The Expanding Symbol is what makes Book of Dead thrilling. During free spins, one regular symbol turns into an expanding wild. If this symbol appears, it expands to fill the whole reel, generating bigger wins. The API response for each free spin clearly says if an enlargement occurred and the win multiplier that ensued. Your animation should display this spread distinctly to reflect the game’s design and what players look for.
You perform each free spin with a call to `/bonus/spin`. The sequence goes on until all granted spins are consumed. The API keeps track of the bonus round condition, so you only require to send the `bonus_round_id`. Wins accumulate, and the aggregate is granted at the conclusion. Your user screen should show the number of free spins left and the active expanding symbol, maintaining the player updated.
Transaction Integration and Reporting of Transactions
Accuracy of finances is essential. The Book of Dead API does not handle real money. It only computes win amounts. Your platform must remove the stake before calling the spin endpoint, then credit the winnings after you get and validate the result. This demands solid, atomic transaction logic on your backend to prevent 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 record `total_stake` and `total_wins` per player session to calculate 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 perform a daily reconciliation with this data. It ensures that your financial records line up with the provider’s logs, building a clear audit trail.
Error Management and Compliance 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 handle 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 explaining a limit breach, following UK responsible gambling rules.
UK-specific compliance errors demand attention. If a player’s self-exclusion or timeout activates during a game, the API might return a `PLAYER_SUSPENDED` error. Your integration must stop the game session right away and take the player to a safe, non-gambling part of your site. Documenting these events for your compliance team is mandatory. 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 presenting a maintenance message. This improves the user experience and stops your servers from overloading. Configure 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 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 lets you simulate the whole player experience, from signing up and depositing to playing and withdrawing, so you can fix any edge cases.
UK developers should focus on 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 legal requirement.
The sandbox also includes tools to force specific outcomes, like initiating 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 comprehensive automated test suite for these scenarios. Run it frequently, especially before you update your platform or when a new API version is released.