UK engineers and providers who want to integrate the Book of Dead slot to their platforms need solid API documentation to commence. This guide describes the Book of Dead slot API. It details the interfaces, data formats, and how to set it up, all with the UK’s regulated market in mind. You’ll learn about authentication, simulating spins, and handling the game’s well-known Expanding Symbol mechanic. The goal 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 transmitting and accepting data. Designed for high reliability, it holds players engaged even during heavy periods like major football matches. The layout divides the game logic server from the client-side display. This separation ensures that outcomes, like reel stops and bonus triggers, are unpredictable and managed securely on the backend.
In a common setup, your platform is the client https://slotbookof.com/dead/. It initiates sessions and sends player actions. An API gateway takes these requests and channels them to the appropriate game service. For UK operators, this system enables the audit trails and data isolation the Gambling Commission demands. Grasping this process helps with debugging and incorporating custom features like tournaments or special promotions.
The API is stateless. Every request must carry its own authentication and context. This approach aids scalability and stability, allowing the service to handle traffic spikes. To keep things smooth for users, even with network issues, you should add retry logic and connection pooling on your end.
Verification and Secure Session Setup
Safety comes first. The Book of Dead API uses OAuth 2.0 client credentials for authentication. You need 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 renew it automatically to avoid breaking a player’s session.
To start 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 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 gives 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 validate these signatures with our public key to ensure data hasn’t been modified. This step is vital for legal UK operation and secures both you and the player from tampering.
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 chosen stake. The request should include the `game_session_token`, the `stake` in GBP, and an non-mandatory `feature_buy` flag if you offer that. Your system should confirm the player has sufficient funds before calling the API, since the API does not process wallet balances.
The spin response is a detailed JSON object. It includes a `reel_stops` array displaying each reel’s position and a `symbols_matrix` for your client to display. The `winning_lines` array details any payline wins, showing 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 show up anywhere.
For the UK market, the response features required compliance fields. These include a `spin_timestamp` in UTC, a distinct `round_id` for audits, and the `total_payout`. You must store this data for the long term for UKGC reporting and any customer disputes. A best practice is to log it immediately as soon as you get the response, so nothing is lost.
Handling the Free Spin Bonus and Enlarging Sign
When the Free Spins round activates, a different series starts. The first base game spin reply marks the start. Your client then sends `/bonus/initiate` with the `round_id` from that spin. This provides the bonus data: how many free spins were given and, most crucially, the randomly picked `expanding_symbol` for this round.
The Expanding Symbol is what turns Book of Dead exciting. During free spins, one normal symbol turns into an expanding wild. If this symbol hits, it expands to fill the entire reel, generating bigger wins. The API reply for each free spin explicitly says if an expansion happened and the win multiplier that resulted. Your graphic should display this enlargement clearly to reflect the game’s layout and what players look for.
You execute each free spin with a command to `/bonus/spin`. The series goes on until all granted spins are exhausted. The API keeps track of the bonus round condition, so you only require to transmit the `bonus_round_id`. Wins add up, and the sum is awarded at the end. Your user interface should present the number of free spins remaining and the current expanding symbol, ensuring the player updated.
Financial Integration and Transaction Reporting
Precision in finances is critical. The Book of Dead API does not handle real money. It only determines win amounts. Your platform must subtract the stake before triggering the spin endpoint, then credit the winnings after you receive and verify the result. This requires 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 record `total_stake` and `total_wins` per player session to work out Gross Gambling Yield for regulatory reports.
We provide a `/transactions/history` endpoint for reconciliation. You can request it with a date range or a specific `round_id` to retrieve a signed record of all transactions. UK licensees typically run a daily reconciliation with this data. It verifies that your financial records match with the provider’s logs, building a clear audit trail.
Error Handling and Regulatory Compliance for the UK Market
Good gov.uk error handling keeps things stable. The API utilizes standard HTTP status codes along with a specific `error_code` and `message` in the response body. Common errors include `INSUFFICIENT_BALANCE` (which you should catch before the request), `SESSION_EXPIRED`, and `BET_LIMIT_EXCEEDED`. Your code must manage 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 demand attention. If a player’s self-exclusion or timeout triggers during a game, the API might return a `PLAYER_SUSPENDED` error. Your integration must terminate the game session right away and take the player to a secure, non-gambling part of your site. Documenting these events for your compliance team is required. The same applies for age verification failures; gameplay must cease immediately.
Think about using https://www.crunchbase.com/organization/rabbit-entertainment a circuit breaker pattern for API calls. If you experience several timeouts or server errors (5xx statuses) in a row, your system should stop trying and fail gracefully, maybe presenting a maintenance message. This boosts the user experience and prevents your servers from overloading. Establish monitoring to warn your tech team if 4xx or 5xx error rates rise, so they can look into quickly.
Testing and Modeling in a Isolated Environment
Never go live without comprehensive 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 allows 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 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 initiating a bonus or a losing spin. This is extremely 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 consistently, especially before you update your platform or when a new API version is released.
