UK engineers and providers who want to add the Book of Dead slot to their platforms need reliable API documentation to start. This guide explains the Book of Dead slot API. It outlines the interfaces, data formats, and how to implement it, all with the UK’s regulated market in mind. You’ll find out about authentication, running spins, and managing the game’s well-known Expanding Symbol feature. The aim is a reliable, legally compliant implementation.
Understanding the Book of Dead API Design
The Book of Dead slot API is a RESTful service that uses JSON for sending and fetching data. Developed for high availability, it maintains players engaged even during peak periods like major football matches. The design separates the game logic server from the client-side interface. This separation ensures that findings, like reel stops and bonus triggers, are arbitrary and managed securely on the backend.
In a common integration, your platform is the client. It starts sessions and sends player actions. An API gateway takes these requests and routes them to the appropriate game service. For UK operators, this system supports the audit trails and data segregation the Gambling Commission requires. Comprehending this flow assists 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 supports scalability and reliability, allowing the service to cope with traffic spikes. To ensure things smooth for users, even with network issues, you should add retry logic and connection pooling on your end.
Security and Secure Session Start
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 communication happens over HTTPS, with a bearer token placed in the `Authorization` header. Since this token runs out, your code must update it automatically to avoid breaking a player’s session.
To start a game session, send a POST request to `/session/start` https://slotbookof.com/dead/. 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 integrate with timeout and limit functions. 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 check these signatures with our public key to confirm data hasn’t been altered. This step is essential for legal UK operation and safeguards both you and the player from tampering.
Core Gameplay Endpoints: Spin and Outcome
The main endpoint for play is `/game/spin`. A POST request to this endpoint executes 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 enough funds before calling the API, since the API does not process wallet balances.
The spin response comes as a detailed JSON object. It includes a `reel_stops` array indicating each reel’s position and a `symbols_matrix` for your client to display. The `winning_lines` array lists any payline wins, specifying the line number, symbol, and payout. Importantly, it informs you if the Free Spins bonus round began, which happens when three or more Book scatter symbols show up anywhere.
For the UK market, the response contains required compliance fields. These include a `spin_timestamp` in UTC, a specific `round_id` for audits, and the `total_payout`. You are required to store this data permanently for UKGC reporting and any customer disputes. A recommended approach is to log it in real-time as soon as you obtain the response, so nothing goes missing.
Processing the Free Spins Bonus and Growing Sign
When the Free Spins bonus starts, a separate series commences. The initial base game spin response indicates the activation. Your client then calls `/bonus/initiate` with the `round_id` from that spin. This returns the bonus details: how many free spins were granted and, most significantly, the randomly chosen `expanding_symbol` for this round.
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 whole reel, producing bigger wins. The API response for each free spin clearly says if an spread occurred and the win rate that resulted. Your animation should show this expansion clearly to match the game’s style and what players look for.
You perform each free spin with a command to `/bonus/spin`. The sequence proceeds until all given spins are consumed. The API monitors the bonus round condition, so you only have to send the `bonus_round_id`. Wins build up, and the sum is awarded at the finish. Your user interface should show the number of free spins left and the active expanding symbol, ensuring the player updated.
Transaction Integration and Reporting of Transactions
Precision in finances is crucial. The Book of Dead API does not touch real money. It only computes win amounts. Your platform must subtract the stake before triggering the spin endpoint, then credit the winnings after you get and validate 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 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 obtain a signed record of all transactions. UK licensees typically perform a daily reconciliation with this data. It checks that your financial records match with the provider’s logs, building a clear audit trail.
Error Handling and Regulation for the UK Market
Good 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 process these smoothly, perhaps by sending 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 respond with a `PLAYER_SUSPENDED` error. Your integration must halt the game session right away and redirect the player to a safe, non-gambling part of your site. Documenting these events for your compliance team is required. The same applies for age verification failures; gameplay must stop immediately.
Implement 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 handle failure smoothly, maybe showing a maintenance message. This boosts the user experience and stops your servers from overloading. Establish monitoring to warn your tech team if 4xx or 5xx error rates rise, so they can investigate quickly.
Trialing and Modeling in a Isolated Environment
Never go live without comprehensive testing in the sandbox. This environment reflects 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 allows 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 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 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 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 regularly, especially before you update your platform or when a new API version is released.