UK developers and platforms who want to integrate the Slot Book Of Dead Deposit to their systems need reliable API documentation to start. This guide covers the Book of Dead slot API. It walks through the interfaces, data structures, and how to set it up, all with the UK’s regulated market in mind. You’ll discover about authentication, running spins, and managing the game’s famous Expanding Symbol function. The goal is a trustworthy, legally compliant integration.
Understanding the Book of Dead API Architecture
The Book of Dead slot API is a REST-based service that uses JSON for transmitting and accepting data. Developed for high reliability, it keeps players involved even during heavy periods like major football matches. The architecture splits the game logic server from the client-side presentation. This separation ensures that outcomes, like reel stops and bonus triggers, are arbitrary and handled securely on the backend.
In a common implementation, your platform is the client. It starts sessions and forwards player actions. An API gateway takes these requests and directs them to the right game service. For UK operators, this structure supports the audit trails and data segregation the Gambling Commission mandates. Comprehending this sequence aids with debugging and incorporating custom features like tournaments or special promotions.
The API is stateless. Every request must include its own authentication and context. This method supports scalability and stability, allowing the service to cope with traffic spikes. To keep things seamless for users, even with network problems, you should implement retry logic and connection pooling on your end.
Verification and Protected Session Start
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 becomes invalid, your code must update it automatically to avoid breaking 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 preference. For UK compliance, you must also include the player’s current session ID from your responsible gambling tools. This enables 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 verify these signatures with our public key to verify data hasn’t been altered. This step is crucial for legal UK operation and safeguards both you and the player from interference.
Core Gameplay Endpoints: Spin and Outcome
The primary endpoint for play is `/game/spin`. A POST request to this endpoint triggers a single spin at the player’s chosen stake. The request must include the `game_session_token`, the `stake` in GBP, and an elective `feature_buy` flag if you provide that. Your system must check the player has enough funds before calling the API, since the API does not manage wallet balances.
The spin response is 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 details any payline wins, showing the line number, symbol, and payout. Critically, it tells you if the Free Spins bonus round was triggered, which occurs when three or more Book scatter symbols appear anywhere.
For the UK market, the response contains required compliance fields. These include a `spin_timestamp` in UTC, a unique `round_id` for audits, and the `total_payout`. You need to store this data for the long term for UKGC reporting and any customer disputes. A good practice is to log it immediately as soon as you get the response, so nothing is lost.
Handling the Free Spin Feature and Enlarging Symbol
When the Free Spins bonus activates, a separate series begins. The first base game spin response marks 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 given and, most significantly, the randomly selected `expanding_symbol` for this game.
The Expanding Symbol is what makes Book of Dead exciting. During free spins, one standard symbol turns into an expanding wild. If this symbol lands, it stretches to fill the entire reel, generating bigger wins. The API response for each free spin explicitly states if an spread took place and the win rate that resulted. Your graphic should show this expansion distinctly to reflect the game’s design and what players expect.
You execute each free spin with a command to `/bonus/spin`. The run goes on until all awarded spins are consumed. The API keeps track of the bonus round state, so you only need to send the `bonus_round_id`. Wins build up, and the total is given at the conclusion. Your user display should show the number of free spins left and the live expanding symbol, keeping the player updated.
Payment Integration and Financial Reporting
Accuracy of finances is critical. The Book of Dead API does not handle real money. It only calculates win amounts. Your platform must subtract the stake before invoking the spin endpoint, then apply the winnings after you get and validate the result. This needs robust, 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 deposit this amount to the player’s balance. UK operators also need to monitor `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 fetch it with a date range or a specific `round_id` to obtain 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, establishing a clear audit trail.
Error Management and Compliance for the UK Market
Good error handling keeps things stable. The API employs 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 process these gracefully, perhaps by directing 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 halt the game session right away and redirect the player to a protected, non-gambling part of your site. Recording these events for your compliance team is compulsory. The same goes for age verification failures; gameplay must halt immediately.
Implement using a circuit breaker pattern for API calls. If you encounter several timeouts or server errors (5xx statuses) in a row, your system should back off and degrade gracefully, maybe displaying a maintenance message. This boosts the user experience and avoids your servers from overloading. Set up monitoring to warn your tech team if 4xx or 5xx error rates climb, so they can diagnose quickly.
Testing and Simulation in a Test Environment
Never go live without extensive testing in the sandbox. This environment reflects 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 resolve 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 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 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 comprehensive automated test suite for these scenarios. Run it frequently, especially before you update your platform or when a new API version is released.