UK engineers and providers who want to add the Book of Dead slot to their systems need reliable API documentation to begin https://slotbookof.com/dead/. This guide covers the Book of Dead slot API. It walks through the routes, data formats, and how to configure it, all with the UK’s regulated market in mind. You’ll learn about verification, simulating spins, and managing the game’s iconic Expanding Symbol function. The aim is a reliable, legally compliant integration.
Grasping the Book of Dead API Structure
The Book of Dead slot API is a web service that uses JSON for transmitting and fetching data. Built for high uptime, it holds players engaged even during busy periods like major football matches. The layout separates the game logic server from the client-side presentation. This split guarantees that outcomes, like reel stops and bonus triggers, are random and processed securely on the backend.
In a typical setup, your platform is the client. It starts sessions and sends player actions. An API gateway accepts these requests and routes them to the correct game service. For UK operators, this system supports the audit trails and data segregation the Gambling Commission requires. Grasping this process 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 aids scalability and dependability, allowing the service to manage traffic spikes. To maintain things smooth for users, even with network issues, you should add retry logic and connection pooling on your end.
Security and Secure Session Start
Safety comes first. The Book of Dead API uses OAuth 2.0 client credentials for authorisation. You need 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 runs out, your code must renew it automatically to avoid interrupting a player’s session.
To initiate 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 enables the game link with timeout and limit features. The response provides 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 validate these signatures with our public key to confirm data hasn’t been modified. This step is crucial for legal UK operation and protects both you and the player from alteration.
Key Gameplay Endpoints: Spin and Payout
The key endpoint for play is `/game/spin`. A POST request to this endpoint triggers a single spin at the player’s selected stake. The request needs to include the `game_session_token`, the `stake` in GBP, and an optional `feature_buy` flag if that is available. Your system should confirm the player has enough funds before calling the API, as the API does not process wallet balances.
The spin response returns a detailed JSON object. It contains a `reel_stops` array displaying each reel’s position and a `symbols_matrix` for your client to animate. The `winning_lines` array details any payline wins, specifying the line number, symbol, and payout. Critically, it tells you if the Free Spins bonus round was triggered, which takes place when three or more Book scatter symbols land anywhere.
For the UK market, the response contains required compliance fields. These comprise a `spin_timestamp` in UTC, a unique `round_id` for audits, and the `total_payout`. You are required to store this data permanently for UKGC reporting and any customer disputes. A best practice is to log it synchronously as soon as you obtain the response, so nothing goes missing.
Handling the Bonus Spins Feature and Enlarging Symbol
When the Free Spins feature activates, a distinct series begins. The initial base game spin reply signals the activation. Your client then sends `/bonus/initiate` with the `round_id` from that spin. This gives the bonus details: how many free spins were awarded and, most significantly, the randomly chosen `expanding_symbol` for this game.
The Expanding Symbol is what turns Book of Dead engaging. During free spins, one normal symbol changes into an expanding wild. If this symbol appears, it extends to fill the entire reel, creating bigger wins. The API response for each free spin plainly indicates if an spread occurred and the win factor that followed. Your animation should display this expansion distinctly to align with the game’s style and what players expect.
You carry out each free spin with a command to `/bonus/spin`. The sequence proceeds until all awarded spins are consumed. The API monitors the bonus round condition, so you only require to transmit the `bonus_round_id`. Wins build up, and the total is granted at the finish. Your user screen should display the quantity of free spins remaining and the current expanding symbol, ensuring the player informed.
Transaction Integration and Reporting of Transactions
Financial accuracy is crucial. The Book of Dead API does not process real money. It only calculates win amounts. Your platform must remove the stake before calling the spin endpoint, then credit the winnings after you get and confirm the result. This demands 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 deposit this amount to the player’s balance. UK operators also need to track `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 request it with a date range or a specific `round_id` to pull a signed record of all transactions. UK licensees typically perform 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 Handling and Compliance for the UK Market
Proper error handling ensures stability. The API employs 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 directing the player to a deposit page or explaining a limit breach, following UK responsible gambling rules.
UK-specific compliance errors require attention. If a player’s self-exclusion or timeout activates during a game, the API might send a `PLAYER_SUSPENDED` error. Your integration must terminate the game session right away and take the player to a safe, non-gambling part of your site. Logging these events for your compliance team is compulsory. The same goes for age verification failures; gameplay must stop immediately.
Think about using a circuit breaker pattern for API calls. If you experience several timeouts or server errors (5xx statuses) in a row, your system should cease attempts and degrade gracefully, maybe displaying a maintenance message. This improves the user experience and prevents your servers from overloading. Establish monitoring to warn your tech team if 4xx or 5xx error rates rise, so they can diagnose quickly.
Simulation and Simulation in a Test Environment
Never go live without comprehensive testing in the sandbox. This environment mirrors 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 focus on key test scenarios. Simulate 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 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 complete automated test suite for these scenarios. Run it regularly, especially before you update your platform or when a new API version is released.