UK engineers and providers who want to integrate the Book of Dead slot to their systems need solid API documentation to begin. This guide explains the Book of Dead slot API. It outlines the interfaces, data formats, and how to set it up, all with the UK’s regulated market in mind. You’ll discover about verification, running spins, and managing the game’s iconic Expanding Symbol feature. The objective is a dependable, legally valid setup.
Grasping the Book of Dead API Structure
The Book of Dead slot API is a web service that uses JSON for sending and fetching data. Developed for high availability, it maintains players involved even during busy periods like major football matches. The design splits the game logic server from the client-side interface. This split assures that outcomes, like reel stops and bonus triggers, are unpredictable and processed securely on the backend.
In a common integration, your platform is the client. It starts sessions and transmits player actions. An API gateway takes these requests and routes them to the appropriate game service. For UK operators, this system facilitates the audit trails and data isolation the Gambling Commission mandates. Understanding this process helps with debugging and introducing 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 reliability, letting the service to manage traffic spikes. To keep things smooth for users, even with network problems, you should include retry logic and connection pooling on your end.
Authentication and Protected Session Start
Protection comes first. The Book of Dead API uses OAuth 2.0 client credentials for verification. You require 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 becomes invalid, your code must refresh it automatically to avoid interrupting a player’s session.
To start 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 configuration. For UK compliance, you must also include the player’s current session ID from your responsible gambling tools. This allows the game connect with timeout and limit capabilities. The response provides 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 modified. This step is crucial for legal UK operation and protects both you and the player from alteration.
Core Gameplay Endpoints: Spin and Result
The key endpoint for play is `/game/spin`. A POST request to this endpoint executes a single spin at the player’s chosen stake. The request should include the `game_session_token`, the `stake` in GBP, and an elective `feature_buy` flag if you provide that. Your system needs to verify the player has adequate funds before calling the API, as the API does not manage wallet balances.
The spin response is a detailed JSON object. It contains a `reel_stops` array showing each reel’s position and a `symbols_matrix` for your client to render. The `winning_lines` array describes any payline wins, showing the line number, symbol, and payout. Importantly, it tells you if the Free Spins bonus round began, 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 good practice is to log it synchronously as soon as you get the response, so nothing is lost.
Handling the Free Spins Feature and Expanding Icon
When the Free Spins feature activates, a distinct sequence begins. The original base game spin result indicates the trigger. Your client then calls `/bonus/initiate` with the `round_id` from that spin. This provides the bonus data: how many free spins were granted and, most significantly, the randomly selected `expanding_symbol` for this round.
The Expanding Symbol is what renders Book of Dead thrilling. During free spins, one regular symbol changes into an expanding wild. If this symbol appears, it stretches to fill the full reel, producing bigger wins. The API answer for each free spin plainly states if an spread happened and the win multiplier that ensued. Your graphic should demonstrate this enlargement clearly to reflect the game’s style and what players anticipate.
You execute each free spin with a call to `/bonus/spin`. The run proceeds until all granted spins are consumed. The API tracks the bonus round condition, so you only have to submit the `bonus_round_id`. Wins build up, and the aggregate is given at the finish. Your user display should show the quantity of free spins remaining and the current expanding symbol, ensuring the player informed.
Payment Integration and Transaction Reporting
Financial accuracy is critical https://slotbookof.com/dead/. The Book of Dead API does not touch real money. It only determines win amounts. Your platform must deduct the stake before triggering the spin endpoint, then apply the winnings after you get and verify the result. This requires strong, 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 calculate Gross Gambling Yield for regulatory reports.
We provide a `/transactions/history` endpoint for reconciliation. You can query 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 ensures that your financial records line up with the provider’s logs, creating a clear audit trail.
Error Processing and Regulation for the UK Market
Good error handling keeps things stable. The API uses 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 process these smoothly, perhaps by directing the player to a deposit page or describing 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 respond with a `PLAYER_SUSPENDED` error. Your integration must stop the game session right away and take the player to a secure, non-gambling part of your site. Logging these events for your compliance team is compulsory. 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 cease attempts and handle failure smoothly, maybe presenting a maintenance message. This improves the user experience and prevents your servers from overloading. Establish monitoring to notify your tech team if 4xx or 5xx error rates increase, so they can investigate quickly.
Testing and Modeling in a Isolated Environment
Never go live without thorough 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 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 concentrate on 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 work. 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 activating 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 complete automated test suite for these scenarios. Run it consistently, especially before you update your platform or when a new API version is released.