Book of Dead Game API Documentation for UK Developers

UK engineers and operators who want to integrate the Book of Dead slot to their platforms need comprehensive API documentation to start //slotbookof.com/dead/. This guide explains the Book of Dead slot API. It outlines the routes, data types, and how to set it up, all with the UK’s regulated market in mind. You’ll discover about authorization, testing spins, and managing the game’s famous Expanding Symbol feature. The aim is a trustworthy, legally sound integration.

Grasping the Book of Dead API Design

The Book of Dead slot API is a REST-based service that uses JSON for sending and fetching data. Developed for high availability, it keeps players involved even during peak periods like major football matches. The architecture splits the game logic server from the client-side display. This division ensures that findings, like reel stops and bonus triggers, are unpredictable and handled securely on the backend.

In a common implementation, your platform is the client. It initiates sessions and forwards player actions. An API gateway takes these requests and channels them to the appropriate game service. For UK operators, this structure facilitates the audit trails and data segregation the Gambling Commission mandates. Understanding this flow aids with debugging and adding custom features like tournaments or special promotions.

The API is stateless. Every request must carry its own authentication and context. This strategy aids scalability and reliability, letting the service to manage traffic spikes. To ensure things smooth for users, even with network problems, you should implement retry logic and connection pooling on your end.

Authentication and Safe 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 exchange happens over HTTPS, with a bearer token placed in the `Authorization` header. Since this token runs out, your code must refresh it automatically to avoid interrupting 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 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 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 check these signatures with our public key to verify data hasn’t been altered. This step is crucial for legal UK operation and safeguards both you and the player from alteration.

Key Gameplay Endpoints: Spin and Outcome

The main endpoint for play is `/game/spin`. A POST request to this endpoint triggers a single spin at the player’s picked stake. The request needs to include the `game_session_token`, the `stake` in GBP, and an elective `feature_buy` flag if you offer that. Your system needs to verify the player has sufficient funds before calling the API, since the API does not process wallet balances.

The spin response is a detailed JSON object. It contains 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 tells you if the Free Spins bonus round began, which takes place when three or more Book scatter symbols appear anywhere.

For the UK market, the response contains required compliance fields. These include a `spin_timestamp` in UTC, a specific `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 synchronously as soon as you obtain the response, so nothing is lost.

Processing the Free Spins Bonus and Growing Symbol

When the Free Spins feature triggers, a different series commences. The first base game spin result signals the start. Your client then calls `/bonus/initiate` with the `round_id` from that spin. This returns the bonus information: how many free spins were awarded and, most significantly, the randomly picked `expanding_symbol` for this round.

The Expanding Symbol is what turns Book of Dead exciting. During free spins, one regular symbol turns into an expanding wild. If this symbol appears, it expands to fill the whole reel, creating bigger wins. The API answer for each free spin clearly states if an spread occurred and the win factor that resulted. Your visual should show this enlargement distinctly to match the game’s design and what players anticipate.

You perform each free spin with a command to `/bonus/spin`. The run proceeds until all awarded spins are exhausted. The API tracks the bonus round status, so you only have to send the `bonus_round_id`. Wins build up, and the sum is granted at the end. Your user interface should show the count of free spins remaining and the current expanding symbol, ensuring the player informed.

Financial Integration and Transaction Reporting

Financial accuracy is critical. The Book of Dead API does not process real money. It only computes 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 requires solid, 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 work out Gross Gambling Yield for regulatory reports.

We provide a `/transactions/history` endpoint for reconciliation. You can request it with a date range or a specific `round_id` to pull a signed record of all transactions. UK licensees typically conduct 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 Management and Compliance for the UK Market

Proper error handling ensures stability. The API uses standard HTTP status codes along with a specific `error_code` and `message` in the response body. Common errors include `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 clarifying a limit breach, following UK responsible gambling rules.

UK-specific compliance errors need attention. If a player’s self-exclusion or timeout occurs during a game, the API might send a `PLAYER_SUSPENDED` error. Your integration must halt the game session right away and redirect the player to a protected, non-gambling part of your site. Documenting these events for your compliance team is required. 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 cease attempts and degrade gracefully, maybe presenting a maintenance message. This improves the user experience and avoids your servers from overloading. Establish monitoring to notify your tech team if 4xx or 5xx error rates increase, so they can diagnose quickly.

Testing and Modeling in a Isolated Environment

Never go live without comprehensive testing in the sandbox. This environment emulates the live API but uses test money and has no effect on 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 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 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 comprehensive automated test suite for these scenarios. Run it consistently, especially before you update your platform or when a new API version is released.