UK developers and operators who want to integrate the Book of Dead slot to their platforms need reliable API documentation to commence. This guide describes the Book of Dead slot API. It outlines the interfaces, data structures, and how to implement it, all with the UK’s regulated market in mind. You’ll discover about authorization, running spins, and managing the game’s iconic Expanding Symbol mechanic. The goal is a reliable, legally valid implementation.
Understanding the Book of Dead API Structure
The Book of Dead slot API is a REST-based service that uses JSON for transmitting and accepting data. Designed for high reliability, it keeps players involved even during peak periods like major football matches. The layout separates the game logic server from the client-side presentation. This division ensures that outcomes, like reel stops and bonus triggers, are arbitrary and managed securely on the backend.
In a typical integration, your platform is the client. It starts sessions and sends player actions. An API gateway receives these requests and channels them to the correct game service. For UK operators, this system facilitates the audit trails and data segregation the Gambling Commission mandates. Grasping this flow aids with debugging and adding custom features like tournaments or special promotions.
The API is stateless. Every request must carry its own authentication and context. This strategy promotes scalability and dependability, allowing the service to handle traffic spikes. To keep things smooth for users, even with network hiccups, you should add retry logic and connection pooling on your end.
Security and Secure Session Setup
Protection 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 communication happens over HTTPS, with a bearer token placed in the `Authorization` header. Since this token runs out, your code must refresh 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 integrate with timeout and limit capabilities. The response returns 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 verify data hasn’t been modified. This step is essential for legal UK operation and protects both you and the player from interference.
Main Gameplay Endpoints: Spin and Payout
The key endpoint for play is `/game/spin`. A POST request to this endpoint places a single spin at the player’s selected stake. The request needs to include the `game_session_token`, the `stake` in GBP, and an elective `feature_buy` flag if that is available. Your system should confirm the player has sufficient funds before calling the API, because the API does not process wallet balances.
The spin response returns a detailed JSON object. It holds 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, listing the line number, symbol, and payout. Crucially, it indicates if the Free Spins bonus round began, which happens when three or more Book scatter symbols land anywhere.
For the UK market, the response contains required compliance fields. These are 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 recommended approach is to log it synchronously as soon as you get the response, so nothing goes missing.
Handling the Free Spins Bonus and Expanding Symbol
When the Free Spins round starts, a distinct sequence begins. The first base game spin reply signals the trigger. Your client then calls `/bonus/initiate` with the `round_id` from that spin. This gives the bonus data: how many free spins were awarded and, most importantly, the randomly chosen `expanding_symbol` for this round.
The Expanding Symbol is what makes Book of Dead thrilling. During free spins, one normal symbol turns into an expanding wild. If this symbol appears, it expands to fill the entire reel, creating bigger wins. The API answer for each free spin plainly states if an enlargement took place and the win factor that ensued. Your visual should demonstrate this spread clearly to reflect the game’s design and what players look for.
You execute each free spin with a request to `/bonus/spin`. The sequence goes on until all granted spins are used up. The API monitors the bonus round state, so you only have to submit the `bonus_round_id`. Wins build up, and the sum is given at the conclusion. Your user screen should present the count of free spins available and the active expanding symbol, keeping the player updated.
Financial Integration and Reporting of Transactions
Financial accuracy is crucial. The Book of Dead API does not handle real money. It only computes win amounts. Your platform must remove the stake before triggering the spin endpoint, then add the winnings after you get and verify the result. This needs solid, 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 https://slotbookof.com/dead/. The `payout` value in the response is the net win for that spin (the total win minus the stake). You allocate 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 offer 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 run 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 Handling and Compliance for the UK Market
Proper 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 consist of `INSUFFICIENT_BALANCE` (which you should catch before the request), `SESSION_EXPIRED`, and `BET_LIMIT_EXCEEDED`. Your code must manage these gracefully, perhaps by sending the player to a deposit page or describing 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 respond with a `PLAYER_SUSPENDED` error. Your integration must stop the game session right away and take the player to a protected, non-gambling part of your site. Documenting these events for your compliance team is mandatory. The same applies for age verification failures; gameplay must halt immediately.
Consider 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 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 rise, so they can investigate quickly.
Trialing and Testing in a Isolated Environment
Never go live without comprehensive testing in the sandbox. This environment emulates 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 fix any edge cases.
UK developers should prioritize 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 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 regulatory requirement.
The sandbox also includes tools to force specific outcomes, like activating a bonus or a losing spin. This is very 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 frequently, especially before you update your platform or when a new API version is released.
