UK developers and providers who want to add the Book of Dead slot to their sites need solid API documentation to start https://slotbookof.com/dead/. This guide covers the Book of Dead slot API. It outlines the endpoints, data types, and how to set it up, all with the UK’s regulated market in mind. You’ll discover about authentication, simulating spins, and handling the game’s famous Expanding Symbol feature. The objective is a dependable, legally compliant integration.
Grasping the Book of Dead API Structure
The Book of Dead slot API is a REST-based service that uses JSON for exchanging and accepting data. Developed for high uptime, it maintains players involved even during busy periods like major football matches. The architecture divides the game logic server from the client-side display. This separation ensures that outcomes, like reel stops and bonus triggers, are random and processed securely on the backend.
In a common setup, your platform is the client. It initiates sessions and transmits player actions. An API gateway accepts these requests and channels them to the appropriate game service. For UK operators, this structure enables the audit trails and data separation the Gambling Commission mandates. Understanding this sequence helps with debugging and incorporating custom features like tournaments or special promotions.
The API is stateless. Every request must include its own authentication and context. This approach promotes scalability and reliability, letting the service to handle traffic spikes. To keep things smooth for users, even with network problems, you should include retry logic and connection pooling on your end.
Verification and Safe Session Initialisation
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 communication happens over HTTPS, with a bearer token placed in the `Authorization` header. Since this token becomes invalid, 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 preference. For UK compliance, you must also include the player’s current session ID from your responsible gambling tools. This allows the game integrate with timeout and limit capabilities. The response gives 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 ensure data hasn’t been changed. This step is crucial for legal UK operation and safeguards both you and the player from tampering.
Core Gameplay Endpoints: Spin and Outcome
The key endpoint for play is `/game/spin`. A POST request to this endpoint places a single spin at the player’s selected stake. The request must include the `game_session_token`, the `stake` in GBP, and an optional `feature_buy` flag if you provide that. Your system must check the player has enough funds before calling the API, as the API does not handle wallet balances.
The spin response returns a detailed JSON object. It includes a `reel_stops` array indicating each reel’s position and a `symbols_matrix` for your client to render. The `winning_lines` array describes any payline wins, listing the line number, symbol, and payout. Crucially, it informs you if the Free Spins bonus round was triggered, which takes place when three or more Book scatter symbols show up anywhere.
For the UK market, the response features required compliance fields. These are a `spin_timestamp` in UTC, a distinct `round_id` for audits, and the `total_payout`. You must store this data indefinitely for UKGC reporting and any customer disputes. A good practice is to log it immediately as soon as you receive the response, so nothing is lost.
Handling the Bonus Spins Feature and Growing Symbol
When the Free Spins round activates, a different process commences. The first base game spin response signals the activation. Your client then requests `/bonus/initiate` with the `round_id` from that spin. This returns the bonus data: how many free spins were awarded and, most significantly, the randomly selected `expanding_symbol` for this round.
The Expanding Symbol is what makes Book of Dead exciting. During free spins, one regular symbol turns into an expanding wild. If this symbol appears, it stretches to fill the full reel, producing bigger wins. The API response for each free spin explicitly indicates if an spread occurred and the win multiplier that ensued. Your visual should demonstrate this enlargement vividly to match the game’s layout and what players expect.
You carry out each free spin with a command to `/bonus/spin`. The sequence goes on until all awarded spins are used up. The API tracks the bonus round state, so you only require to transmit the `bonus_round_id`. Wins build up, and the sum is awarded at the conclusion. Your user display should present the number of free spins left and the current expanding symbol, keeping the player aware.
Payment Integration and Reporting of Transactions
Accuracy of finances is crucial. The Book of Dead API does not handle real money. It only computes win amounts. Your platform must deduct the stake before invoking the spin endpoint, then add the winnings after you receive and validate the result. This needs 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 monitor `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 fetch it with a date range or a specific `round_id` to pull a signed record of all transactions. UK licensees typically run 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 Regulatory Compliance for the UK Market
Good 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 gracefully, perhaps by directing 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 activates during a game, the API might return a `PLAYER_SUSPENDED` error. Your integration must terminate the game session right away and move the player to a secure, non-gambling part of your site. Logging these events for your compliance team is mandatory. The same applies for age verification failures; gameplay must cease 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 cease attempts and handle failure smoothly, maybe displaying a maintenance message. This boosts the user experience and avoids your servers from overloading. Establish monitoring to alert your tech team if 4xx or 5xx error rates climb, so they can look into quickly.
Trialing and Modeling in a Test Environment
Never go live without thorough testing in the sandbox. This environment reflects the live API but uses test money and doesn’t affect 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 address 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 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.
Leave a Reply