UK developers and operators 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 details the endpoints, data formats, and how to set it up, all with the UK’s regulated market in mind. You’ll learn about verification, simulating spins, and controlling the game’s well-known Expanding Symbol mechanic. The goal is a reliable, legally valid integration.
Understanding the Book of Dead API Structure
The Book of Dead slot API is a REST-based service that uses JSON for transmitting and receiving data. Designed for high availability, it holds players entertained even during heavy periods like major football matches. The design divides the game logic server from the client-side presentation. This division assures that results, like reel stops and bonus triggers, are random and managed securely on the backend.
In a typical setup, your platform is the client. It begins sessions and sends player actions. An API gateway takes these requests and channels them to the correct game service. For UK operators, this structure supports the audit trails and data separation the Gambling Commission requires. Comprehending this sequence helps with debugging and introducing custom features like tournaments or special promotions.
The API is stateless. Every request must include its own authentication and context. This method promotes scalability and reliability, allowing the service to handle traffic spikes. To ensure things seamless for users, even with network problems, you should include retry logic and connection pooling on your end.
Verification and Safe Session Start
Security 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 transmission happens over HTTPS, with a bearer token placed in the `Authorization` header. Since this token expires, 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 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 enables the game link with timeout and limit functions. The response provides 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 modified. This step is vital for legal UK operation and secures both you and the player from tampering.
Main Gameplay Endpoints: Spin and Outcome
The main endpoint for play is `/game/spin`. A POST request here triggers a single spin at the player’s selected stake. The request should include the `game_session_token`, the `stake` in GBP, and an non-mandatory `feature_buy` flag if you provide that. Your system should confirm the player has adequate funds before calling the API, because 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 lists any payline wins, showing the line number, symbol, and payout. Critically, it indicates if the Free Spins bonus round began, which occurs when three or more Book scatter symbols appear anywhere.
For the UK market, the response contains required compliance fields. These are a `spin_timestamp` in UTC, a specific `round_id` for audits, and the `total_payout`. You are required to store this data indefinitely for UKGC reporting and any customer disputes. A good practice is to log it in real-time as soon as you receive the response, so nothing is lost.
Handling the Free Spin Feature and Expanding Icon
When the Free Spins round triggers, a different sequence begins. The initial base game spin result indicates the trigger. Your client then calls `/bonus/initiate` with the `round_id` from that spin. This returns the bonus details: how many free spins were given and, most importantly, the randomly chosen `expanding_symbol` for this game.
The Expanding Symbol is what turns Book of Dead exciting. During free spins, one normal symbol changes into an expanding wild. If this symbol hits, it extends to fill the entire reel, creating bigger wins. The API response for each free spin plainly states if an enlargement took place and the win factor that ensued. Your animation should display this expansion clearly to match the game’s design and what players anticipate.
You carry out each free spin with a request to `/bonus/spin`. The series proceeds until all granted spins are exhausted. The API monitors the bonus round condition, so you only require to submit the `bonus_round_id`. Wins add up, and the aggregate is granted at the conclusion. Your user screen should show the number of free spins remaining and the current expanding symbol, keeping the player updated.
Transaction Integration and Reporting of Transactions
Precision in finances is crucial https://slotbookof.com/dead/. The Book of Dead API does not handle real money. It only computes 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 demands robust, 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 allocate this amount to the player’s balance. UK operators also need to track `total_stake` and `total_wins` per player session to calculate Gross Gambling Yield for regulatory reports.
We supply a `/transactions/history` endpoint for reconciliation. You can request 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 line up with the provider’s logs, establishing a clear audit trail.
Error Management and Regulatory Compliance for the UK Market
Good 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 trap before the request), `SESSION_EXPIRED`, and `BET_LIMIT_EXCEEDED`. Your code must handle 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 need attention. If a player’s self-exclusion or timeout occurs during a game, the API might return a `PLAYER_SUSPENDED` error. Your integration must halt the game session right away and take the player to a protected, non-gambling part of your site. Logging these events for your compliance team is required. The same holds true 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 stop trying and degrade gracefully, maybe presenting a maintenance message. This enhances the user experience and stops your servers from overloading. Establish monitoring to notify your tech team if 4xx or 5xx error rates increase, so they can diagnose quickly.
Testing and Modeling in a Test Environment
Never go live without extensive 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 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 legal requirement.
The sandbox also includes tools to force specific outcomes, like initiating 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 comprehensive automated test suite for these scenarios. Run it frequently, especially before you update your platform or when a new API version is released.