UK developers and operators who want to integrate the Book of Dead slot to their platforms need solid API documentation to commence slotbookof.com. This guide describes the Book of Dead slot API. It details the routes, data formats, and how to configure it, all with the UK’s regulated market in mind. You’ll learn about verification, testing spins, and controlling the game’s iconic Expanding Symbol feature. The aim is a dependable, legally valid setup.
Understanding the Book of Dead API Structure
The Book of Dead slot API is a RESTful service that uses JSON for transmitting and receiving data. Built for high availability, it maintains players involved even during peak periods like major football matches. The layout separates the game logic server from the client-side display. This division ensures that outcomes, like reel stops and bonus triggers, are arbitrary and processed securely on the backend.
In a common integration, your platform is the client. It initiates sessions and sends player actions. An API gateway receives these requests and channels them to the appropriate game service. For UK operators, this framework facilitates the audit trails and data isolation the Gambling Commission requires. Understanding this sequence aids 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 aids scalability and stability, letting the service to manage traffic spikes. To keep things seamless for users, even with network hiccups, you should implement 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 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 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 enables the game link with timeout and limit capabilities. The response provides 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 verify these signatures with our public key to confirm data hasn’t been altered. This step is vital for legal UK operation and protects both you and the player from interference.
Core Gameplay Endpoints: Spin and Outcome
The main endpoint for play is `/game/spin`. A POST request here places a single spin at the player’s selected stake. The request must include the `game_session_token`, the `stake` in GBP, and an elective `feature_buy` flag if you provide that. Your system must check the player has enough funds before calling the API, because 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 describes any payline wins, specifying the line number, symbol, and payout. Critically, it indicates if the Free Spins bonus round started, which takes place when three or more Book scatter symbols appear anywhere.
For the UK market, the response includes required compliance fields. These comprise a `spin_timestamp` in UTC, a unique `round_id` for audits, and the `total_payout`. You are required to store this data for the long term for UKGC reporting and any customer disputes. A best practice is to log it in real-time as soon as you obtain the response, so nothing gets lost.
Managing the Bonus Spins Bonus and Enlarging Sign
When the Free Spins round activates, a distinct sequence commences. The original base game spin reply signals the start. Your client then requests `/bonus/initiate` with the `round_id` from that spin. This returns the bonus data: how many free spins were granted and, most importantly, the randomly picked `expanding_symbol` for this session.
The Expanding Symbol is what turns Book of Dead thrilling. During free spins, one standard symbol converts into an expanding wild. If this symbol hits, it stretches to fill the full reel, creating bigger wins. The API response for each free spin explicitly states if an spread happened and the win factor that ensued. Your visual should display this spread clearly to align with the game’s design and what players anticipate.
You carry out each free spin with a command to `/bonus/spin`. The sequence continues until all awarded spins are exhausted. The API monitors the bonus round state, so you only require to submit the `bonus_round_id`. Wins build up, and the sum is granted at the finish. Your user screen should present the number of free spins available and the live expanding symbol, keeping the player aware.
Payment Integration and Reporting of Transactions
Accuracy of finances is essential. The Book of Dead API does not handle real money. It only computes win amounts. Your platform must subtract the stake before triggering the spin endpoint, then credit the winnings after you obtain and confirm the result. This requires robust, atomic transaction logic on your backend to prevent 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 request it with a date range or a specific `round_id` to retrieve a signed record of all transactions. UK licensees typically perform a daily reconciliation with this data. It checks 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 ensures stability. 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 process these seamlessly, 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 activates during a game, the API might return a `PLAYER_SUSPENDED` error. Your integration must halt the game session right away and move the player to a protected, non-gambling part of your site. Documenting these events for your compliance team is compulsory. The same goes for age verification failures; gameplay must halt immediately.
Consider using 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 handle failure smoothly, maybe showing a maintenance message. This enhances the user experience and avoids your servers from overloading. Configure monitoring to notify your tech team if 4xx or 5xx error rates climb, so they can diagnose quickly.
Testing and Simulation in a Sandbox Environment
Never go live without comprehensive testing in the sandbox. This environment emulates 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 lets you 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. 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 frequently, especially before you update your platform or when a new API version is released.