Book of Dead Game API Documentation for UK Developers

UK engineers and operators who want to integrate the Book of Dead slot to their sites need comprehensive API documentation to start. This guide covers the Book of Dead slot API. It walks through the endpoints, data formats, and how to implement it, all with the UK’s regulated market in mind. You’ll find out about authentication, testing spins, and managing the game’s iconic Expanding Symbol function. The aim is a dependable, legally sound setup.

Comprehending the Book of Dead API Architecture

The Book of Dead slot API is a RESTful service that uses JSON for exchanging and accepting data. Built for high uptime, it keeps players entertained even during busy periods like major football matches. The architecture separates the game logic server from the client-side interface. This separation assures that results, like reel stops and bonus triggers, are random and managed securely on the backend.

In a common integration, your platform is the client. It starts sessions and forwards player actions. An API gateway accepts these requests and routes them to the appropriate game service. For UK operators, this framework supports the audit trails and data separation the Gambling Commission demands. Grasping this flow assists with debugging and adding custom features like tournaments or special promotions.

The API is stateless. Every request must contain its own authentication and context. This strategy promotes scalability and reliability, enabling the service to handle traffic spikes. To ensure things smooth for users, even with network issues, you should include retry logic and connection pooling on your end.

Security and Protected Session Initialisation

Security 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 runs out, your code must update it automatically to avoid breaking a player’s session.

To start 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 configuration. For UK compliance, you must also include the player’s current session ID from your responsible gambling tools. This lets the game link with timeout and limit functions. 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 check these signatures with our public key to ensure 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 Result

The primary endpoint for play is `/game/spin` https://slotbookof.com/dead/. A POST request to this endpoint triggers a single spin at the player’s selected 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 adequate funds before calling the API, as the API does not handle wallet balances.

The spin response comes as 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, listing the line number, symbol, and payout. Critically, it informs you if the Free Spins bonus round was triggered, which takes place when three or more Book scatter symbols appear 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 are required to store this data permanently for UKGC reporting and any customer disputes. A recommended approach is to log it in real-time as soon as you obtain the response, so nothing is lost.

Managing the Bonus Spins Bonus and Enlarging Icon

When the Free Spins feature triggers, a distinct series begins. The original base game spin result indicates the activation. Your client then requests `/bonus/initiate` with the `round_id` from that spin. This provides the bonus details: how many free spins were granted and, most importantly, the randomly picked `expanding_symbol` for this game.

The Expanding Symbol is what makes Book of Dead exciting. During free spins, one standard symbol changes into an expanding wild. If this symbol hits, it extends to fill the full reel, generating bigger wins. The API response for each free spin plainly says if an expansion happened and the win multiplier that followed. Your graphic should show this spread distinctly to align with the game’s style and what players anticipate.

You perform each free spin with a request to `/bonus/spin`. The sequence goes on until all granted spins are consumed. The API monitors the bonus round condition, so you only have to send the `bonus_round_id`. Wins build up, and the total is given at the end. Your user display should present the count of free spins available and the current expanding symbol, ensuring the player aware.

Transaction Integration and Reporting of Transactions

Accuracy of finances is crucial. The Book of Dead API does not process real money. It only calculates win amounts. Your platform must deduct the stake before invoking the spin endpoint, then credit the winnings after you obtain and confirm the result. This needs strong, 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 deposit this amount to the player’s balance. UK operators also need to record `total_stake` and `total_wins` per player session to determine 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 run a daily reconciliation with this data. It verifies that your financial records line up with the provider’s logs, creating a clear audit trail.

Error Handling and Regulatory Compliance for the UK Market

Proper 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 are `INSUFFICIENT_BALANCE` (which you should catch before the request), `SESSION_EXPIRED`, and `BET_LIMIT_EXCEEDED`. Your code must manage these gracefully, perhaps by redirecting 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 triggers 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 safe, non-gambling part of your site. Documenting these events for your compliance team is mandatory. The same holds true for age verification failures; gameplay must cease 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 degrade gracefully, maybe displaying a maintenance message. This enhances the user experience and prevents your servers from overloading. Configure monitoring to alert your tech team if 4xx or 5xx error rates climb, so they can investigate quickly.

Testing and Simulation in a Test Environment

Never go live without extensive testing in the sandbox. This environment mirrors 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 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 frequently, especially before you update your platform or when a new API version is released.