Book of Dead Title API Documentation for UK Developers

UK engineers and providers who want to include the Book of Dead slot to their sites need reliable API documentation to commence 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 authentication, testing spins, and controlling the game’s well-known Expanding Symbol feature. The aim is a trustworthy, legally valid implementation.

Understanding the Book of Dead API Design

The Book of Dead slot API is a REST-based service that uses JSON for transmitting and fetching data. Developed for high reliability, it maintains players involved even during peak periods like major football matches. The design separates the game logic server from the client-side interface. This division guarantees that results, like reel stops and bonus triggers, are random and processed securely on the backend.

In a typical setup, your platform is the client. It starts sessions and forwards player actions. An API gateway receives these requests and channels them to the right game service. For UK operators, this system supports the audit trails and data isolation the Gambling Commission mandates. Understanding this flow helps with debugging and introducing custom features like tournaments or special promotions.

The API is stateless. Every request must include its own authentication and context. This method promotes scalability and stability, letting the service to manage traffic spikes. To ensure things smooth for users, even with network hiccups, you should add retry logic and connection pooling on your end.

Authentication and Secure Session Start

Safety 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 transmission happens over HTTPS, with a bearer token placed in the `Authorization` header. Since this token expires, your code must refresh 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 setting. For UK compliance, you must also include the player’s current session ID from your responsible gambling tools. This lets the game integrate with timeout and limit capabilities. 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 verify data hasn’t been changed. This step is vital for legal UK operation and secures both you and the player from interference.

Core Gameplay Endpoints: Spin and Outcome

The key endpoint for play is `/game/spin`. A POST request to this endpoint executes a single spin at the player’s chosen 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 should confirm the player has enough funds before calling the API, because the API does not process wallet balances.

The spin response returns a detailed JSON object. It contains a `reel_stops` array showing each reel’s position and a `symbols_matrix` for your client to animate. The `winning_lines` array describes any payline wins, showing the line number, symbol, and payout. Crucially, it indicates if the Free Spins bonus round began, which happens when three or more Book scatter symbols appear anywhere.

For the UK market, the response features 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 recommended approach is to log it immediately as soon as you obtain the response, so nothing goes missing.

Handling the Free Spins Feature and Growing Icon

When the Free Spins feature activates, a different series starts. The initial base game spin response indicates the trigger. Your client then requests `/bonus/initiate` with the `round_id` from that spin. This gives the bonus details: how many free spins were granted and, most significantly, the randomly chosen `expanding_symbol` for this session.

The Expanding Symbol is what renders Book of Dead thrilling. During free spins, one normal symbol converts into an expanding wild. If this symbol appears, it extends to fill the entire reel, producing bigger wins. The API response for each free spin clearly states if an enlargement took place and the win factor that ensued. Your animation should show this spread clearly to align with the game’s layout and what players anticipate.

You perform each free spin with a call to `/bonus/spin`. The series continues until all awarded spins are consumed. The API keeps track of the bonus round state, so you only need to send the `bonus_round_id`. Wins accumulate, and the aggregate is granted at the end. Your user screen should present the count of free spins available and the current expanding symbol, ensuring the player updated.

Transaction Integration and Financial Reporting

Precision in finances is essential. The Book of Dead API does not process real money. It only computes win amounts. Your platform must remove the stake before calling the spin endpoint, then add the winnings after you receive and verify the result. This needs robust, 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 allocate this amount to the player’s balance. UK operators also need to monitor `total_stake` and `total_wins` per player session to determine Gross Gambling Yield for regulatory reports.

We provide 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 ensures that your financial records line up with the provider’s logs, building a clear audit trail.

Error Handling and Compliance for the UK Market

Effective error handling maintains stability. 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 handle before the request), `SESSION_EXPIRED`, and `BET_LIMIT_EXCEEDED`. Your code must handle these seamlessly, 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 activates during a game, the API might send a `PLAYER_SUSPENDED` error. Your integration must terminate 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 mandatory. The same holds true for age verification failures; gameplay must halt immediately.

Think about 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 stops your servers from overloading. Configure monitoring to notify your tech team if 4xx or 5xx error rates increase, so they can investigate quickly.

Trialing and Modeling in a Isolated Environment

Never go live without comprehensive testing in the sandbox. This environment mirrors 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 resolve 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 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 compliance requirement.

The sandbox also includes tools to force specific outcomes, like initiating 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 regularly, especially before you update your platform or when a new API version is released.