UK programmers and operators who want to add the Book of Dead slot to their platforms need solid API documentation to begin. This guide explains the Book of Dead slot API. It outlines the endpoints, data types, and how to configure it, all with the UK's regulated market in mind. You'll discover about authentication, running spins, and controlling the game's iconic Expanding Symbol mechanic. The objective is a dependable, legally valid setup.
Grasping the Book of Dead API Architecture
The Book of Dead slot API is a RESTful service that uses JSON for exchanging and fetching data. Built for high availability, it holds players entertained even during peak periods like major football matches. The design separates the game logic server from the client-side display. This split guarantees that results, like reel stops and bonus triggers, are unpredictable and handled securely on the backend.
In a common integration, your platform is the client. It starts sessions and forwards player actions. An API gateway accepts these requests and routes them to the right game service. For UK operators, this framework facilitates the audit trails and data segregation the Gambling Commission demands. Comprehending this flow aids with debugging and introducing custom features like tournaments or special promotions.
The API is stateless. Every request must contain its own authentication and context. This strategy aids scalability and dependability, enabling the service to handle traffic spikes. To maintain things smooth for users, even with network issues, you should include retry logic and connection pooling on your end.
Security and Safe Session Initialisation
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 exchange happens over HTTPS, with a bearer token placed in the `Authorization` header. Since this token becomes invalid, your code must update it automatically to avoid breaking a player's session.
To begin 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 integrate with timeout and limit capabilities. The response gives 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 altered. This step is vital for legal UK operation and protects both you and the player from alteration.
Key Gameplay Endpoints: Spin and Result
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 non-mandatory `feature_buy` flag if that is available. Your system must check the player has enough funds before calling the API, because the API does not manage wallet balances.
The spin response is a detailed JSON object https://slotbookof.com/dead/. It includes a `reel_stops` array displaying each reel's position and a `symbols_matrix` for your client to animate. The `winning_lines` array describes any payline wins, showing the line number, symbol, and payout. Importantly, it informs you if the Free Spins bonus round started, which happens when three or more Book scatter symbols appear anywhere.
For the UK market, the response contains 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 in real-time as soon as you receive the response, so nothing is lost.
Processing the Free Spins Feature and Growing Symbol
When the Free Spins round activates, a separate sequence starts. The first base game spin result indicates the activation. Your client then sends `/bonus/initiate` with the `round_id` from that spin. This provides the bonus data: how many free spins were granted and, most importantly, the randomly selected `expanding_symbol` for this round.
The Expanding Symbol is what makes Book of Dead thrilling. During free spins, one standard symbol turns into an expanding wild. If this symbol lands, it expands to fill the full reel, creating bigger wins. The API answer for each free spin clearly says if an enlargement happened and the win multiplier that ensued. Your visual should show this expansion distinctly to align with the game's style and what players expect.
You carry out each free spin with a request to `/bonus/spin`. The run proceeds until all given spins are consumed. The API monitors the bonus round status, so you only require to submit the `bonus_round_id`. Wins add up, and the sum is given at the end. Your user display should display the quantity of free spins available and the current expanding symbol, keeping the player updated.
Transaction Integration and Reporting of Transactions
Financial accuracy is critical. The Book of Dead API does not process real money. It only computes win amounts. Your platform must remove the stake before triggering the spin endpoint, then apply the winnings after you obtain and verify the result. This requires robust, 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 supply 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 ensures that your financial records align with the provider's logs, building a clear audit trail.
Error Processing and Compliance for the UK Market
Good error handling maintains stability. The API uses standard HTTP status codes along with a specific `error_code` and `message` in the response body. Common errors consist of `INSUFFICIENT_BALANCE` (which you should trap before the request), `SESSION_EXPIRED`, and `BET_LIMIT_EXCEEDED`. Your code must handle these gracefully, perhaps by redirecting the player to a deposit page or explaining a limit breach, following UK responsible gambling rules.
UK-specific compliance errors need attention. If a player's self-exclusion or timeout triggers during a game, the API might send a `PLAYER_SUSPENDED` error. Your integration must halt 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 mandatory. The same applies for age verification failures; gameplay must cease 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 presenting a maintenance message. This improves the user experience and avoids your servers from overloading. Set up monitoring to notify your tech team if 4xx or 5xx error rates climb, so they can investigate quickly.
Testing and Testing in a Sandbox Environment
Never go live without comprehensive testing in the sandbox. This environment emulates 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 enables 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. 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 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 triggering 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 thorough automated test suite for these scenarios. Run it consistently, especially before you update your platform or when a new API version is released.