UK engineers and platforms who want to integrate the Book of Dead slot to their systems need reliable API documentation to begin slotbookof.com. This guide explains the Book of Dead slot API. It details the routes, data formats, and how to set it up, all with the UK’s regulated market in mind. You’ll find out about verification, running spins, and controlling the game’s iconic Expanding Symbol feature. The aim is a dependable, legally compliant setup.
Grasping the Book of Dead API Design
The Book of Dead slot API is a web service that uses JSON for sending and fetching data. Developed for high availability, it maintains players engaged even during heavy periods like major football matches. The architecture divides the game logic server from the client-side display. This separation guarantees that outcomes, like reel stops and bonus triggers, are arbitrary and processed securely on the backend.
In a common setup, your platform is the client. It starts sessions and sends player actions. An API gateway takes these requests and routes them to the right game service. For UK operators, this system enables the audit trails and data segregation the Gambling Commission demands. Comprehending this flow assists with debugging and introducing custom features like tournaments or special promotions.
The API is stateless. Every request must contain its own authentication and context. This approach aids scalability and stability, letting the service to handle traffic spikes. To maintain things smooth for users, even with network issues, you should implement retry logic and connection pooling on your end.
Security and Secure Session Start
Security comes first. The Book of Dead API uses OAuth 2.0 client credentials for authorisation. 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 runs out, your code must renew it automatically to avoid breaking a player’s session.
To initiate a game session, send a POST request to `/session/start`. 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 allows the game link with timeout and limit features. The response returns 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 check these signatures with our public key to verify data hasn’t been altered. This step is vital for legal UK operation and secures both you and the player from interference.
Key Gameplay Endpoints: Spin and Payout
The primary endpoint for play is `/game/spin`. A POST request here executes a single spin at the player’s chosen stake. The request should include the `game_session_token`, the `stake` in GBP, and an elective `feature_buy` flag if that is available. Your system needs to verify the player has enough funds before calling the API, because the API does not manage 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 display. The `winning_lines` array describes any payline wins, showing the line number, symbol, and payout. Importantly, it tells you if the Free Spins bonus round began, which occurs when three or more Book scatter symbols show up anywhere.
For the UK market, the response contains required compliance fields. These comprise 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 good practice is to log it in real-time as soon as you get the response, so nothing is lost.
Managing the Free Spin Feature and Growing Symbol
When the Free Spins feature activates, a different series begins. The initial base game spin response signals the start. Your client then sends `/bonus/initiate` with the `round_id` from that spin. This provides the bonus information: how many free spins were awarded and, most importantly, the randomly chosen `expanding_symbol` for this session.
The Expanding Symbol is what turns Book of Dead engaging. During free spins, one normal symbol turns into an expanding wild. If this symbol hits, it extends to fill the whole reel, creating bigger wins. The API response for each free spin explicitly states if an spread took place and the win rate that resulted. Your visual should show this spread vividly to align with the game’s design and what players anticipate.
You perform each free spin with a command to `/bonus/spin`. The sequence goes on until all given spins are exhausted. The API keeps track of the bonus round status, 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 show the count of free spins remaining and the live expanding symbol, keeping the player aware.
Transaction Integration and Reporting of Transactions
Precision in finances is crucial. The Book of Dead API does not process real money. It only determines win amounts. Your platform must subtract the stake before calling the spin endpoint, then add the winnings after you receive and confirm the result. This requires strong, 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 credit this amount to the player’s balance. UK operators also need to track `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 fetch it with a date range or a specific `round_id` to retrieve a signed record of all transactions. UK licensees typically conduct a daily reconciliation with this data. It ensures that your financial records match with the provider’s logs, establishing a clear audit trail.
Error Handling and Compliance for the UK Market
Effective error handling maintains stability. The API utilizes 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 trap 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 explaining 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 return a `PLAYER_SUSPENDED` error. Your integration must stop the game session right away and move the player to a protected, non-gambling part of your site. Recording 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 fail gracefully, maybe showing a maintenance message. This improves the user experience and prevents your servers from overloading. Establish monitoring to alert your tech team if 4xx or 5xx error rates increase, so they can look into quickly.
Testing and Testing in a Test Environment
Never go live without extensive 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 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. 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 function. 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 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 regularly, especially before you update your platform or when a new API version is released.