UK developers and providers who want to add the Book of Dead slot to their systems need reliable API documentation to commence slotbookof.com. This guide covers the Book of Dead slot API. It details the endpoints, data formats, and how to implement it, all with the UK’s regulated market in mind. You’ll discover about authentication, simulating spins, and controlling the game’s iconic Expanding Symbol mechanic. The aim is a dependable, legally valid implementation.
Understanding the Book of Dead API Structure
The Book of Dead slot API is a web service that uses JSON for transmitting and receiving data. Developed for high availability, it keeps players entertained even during peak periods like major football matches. The layout separates the game logic server from the client-side display. This division assures that findings, like reel stops and bonus triggers, are arbitrary and handled securely on the backend.
In a common implementation, your platform is the client. It begins sessions and transmits player actions. An API gateway receives these requests and routes them to the appropriate game service. For UK operators, this system supports the audit trails and data segregation the Gambling Commission mandates. Grasping 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 keep things seamless for users, even with network hiccups, you should implement retry logic and connection pooling on your end.
Verification and Protected Session Start
Protection comes first. The Book of Dead API uses OAuth 2.0 client credentials for authorisation. 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 interrupting a player’s session.
To begin a game session, send a POST request to `/session/start`. The payload needs 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 lets the game connect with timeout and limit features. 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 verify these signatures with our public key to confirm data hasn’t been altered. This step is vital for legal UK operation and secures both you and the player from tampering.
Main 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 selected stake. The request must include the `game_session_token`, the `stake` in GBP, and an non-mandatory `feature_buy` flag if that is available. Your system should confirm the player has enough funds before calling the API, because the API does not manage wallet balances.
The spin response is a detailed JSON object. It holds a `reel_stops` array showing each reel’s position and a `symbols_matrix` for your client to display. The `winning_lines` array lists any payline wins, specifying the line number, symbol, and payout. Crucially, it indicates if the Free Spins bonus round began, which takes place when three or more Book scatter symbols show up anywhere.
For the UK market, the response contains required compliance fields. These are a `spin_timestamp` in UTC, a distinct `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 recommended approach is to log it in real-time as soon as you receive the response, so nothing goes missing.
Managing the Free Spin Feature and Growing Sign
When the Free Spins feature starts, a different series starts. The original base game spin result marks 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 awarded and, most significantly, the randomly selected `expanding_symbol` for this session.
The Expanding Symbol is what turns Book of Dead thrilling. During free spins, one regular symbol changes into an expanding wild. If this symbol lands, it expands to fill the full reel, creating bigger wins. The API reply for each free spin plainly says if an enlargement took place and the win factor that resulted. Your animation should demonstrate this enlargement distinctly to align with the game’s style and what players anticipate.
You perform each free spin with a call to `/bonus/spin`. The series proceeds until all granted spins are used up. The API monitors the bonus round condition, so you only require to send the `bonus_round_id`. Wins add up, and the aggregate is awarded at the conclusion. Your user screen should show the number of free spins available and the active expanding symbol, keeping the player aware.
Transaction Integration and Financial Reporting
Accuracy of finances is critical. The Book of Dead API does not touch real money. It only determines win amounts. Your platform must remove the stake before invoking the spin endpoint, then credit the winnings after you get and verify the result. This needs solid, 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 allocate this amount to the player’s balance. UK operators also need to monitor `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 query 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 verifies that your financial records align with the provider’s logs, building a clear audit trail.
Error Processing and Regulation for the UK Market
Proper error handling keeps things stable. The API uses standard HTTP status codes along with a specific `error_code` and `message` in the response body. Common errors are `INSUFFICIENT_BALANCE` (which you should catch 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 explaining a limit breach, following UK responsible gambling rules.
UK-specific compliance errors demand attention. If a player’s self-exclusion or timeout occurs during a game, the API might send a `PLAYER_SUSPENDED` error. Your integration must stop the game session right away and take the player to a secure, 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 cease immediately.
Implement using a circuit breaker pattern for API calls. If you see several timeouts or server errors (5xx statuses) in a row, your system should cease attempts and degrade gracefully, maybe displaying a maintenance message. This improves the user experience and prevents your servers from overloading. Set up monitoring to warn your tech team if 4xx or 5xx error rates increase, so they can investigate quickly.
Trialing and Simulation in a Sandbox Environment
Never go live without extensive 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 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 concentrate on key test scenarios. Simulate 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 legal requirement.
The sandbox also includes tools to force specific outcomes, like triggering 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 consistently, especially before you update your platform or when a new API version is released.