Book of Dead Slot API Documentation for UK Developers

UK engineers and platforms who want to integrate the Book Of Dead slot to their sites need solid API documentation to commence. This guide describes the Book of Dead slot API. It details the routes, data structures, and how to implement it, all with the UK’s regulated market in mind. You’ll learn about authentication, running spins, and controlling the game’s well-known Expanding Symbol mechanic. The goal is a dependable, legally valid integration.

Understanding the Book of Dead API Design

The Book of Dead slot API is a RESTful service that uses JSON for sending and accepting data. Built for high uptime, it maintains players involved even during busy periods like major football matches. The design splits the game logic server from the client-side interface. This division ensures that findings, like reel stops and bonus triggers, are unpredictable and managed securely on the backend.

In a standard integration, your platform is the client. It begins sessions and transmits player actions. An API gateway takes these requests and directs them to the appropriate game service. For UK operators, this structure supports the audit trails and data separation the Gambling Commission mandates. Grasping this flow aids 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 approach supports scalability and dependability, allowing the service to handle traffic spikes. To keep things fluid for users, even with network issues, you should include retry logic and connection pooling on your end.

Authentication and Protected Session Initialisation

Safety 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 exchange 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 interrupting a player’s session.

To begin 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 allows the game integrate with timeout and limit functions. The response provides 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 validate these signatures with our public key to confirm data hasn’t been altered. This step is essential for legal UK operation and protects both you and the player from alteration.

Core 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 picked stake. The request needs to include the `game_session_token`, the `stake` in GBP, and an non-mandatory `feature_buy` flag if you offer that. Your system needs to verify the player has adequate funds before calling the API, because the API does not process wallet balances.

The spin response comes as a detailed JSON object. It includes a `reel_stops` array indicating each reel’s position and a `symbols_matrix` for your client to animate. The `winning_lines` array lists any payline wins, showing the line number, symbol, and payout. Importantly, 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 are a `spin_timestamp` in UTC, a distinct `round_id` for audits, and the `total_payout`. You need to store this data permanently for UKGC reporting and any customer disputes. A best practice is to log it immediately as soon as you obtain the response, so nothing goes missing.

Handling the Free Spin Reward and Enlarging Icon

When the Free Spins feature activates, a separate sequence begins. The initial base game spin response marks the activation. Your client then calls `/bonus/initiate` with the `round_id` from that spin. This provides the bonus information: 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 engaging. During free spins, one normal symbol changes into an expanding wild. If this symbol hits, it stretches to fill the whole reel, producing bigger wins. The API reply for each free spin explicitly states if an spread took place and the win rate that resulted. Your graphic should show this spread vividly to align with the game’s layout and what players expect.

You carry out each free spin with a command to `/bonus/spin`. The series goes on until all given spins are used up. The API monitors the bonus round state, so you only require to transmit the `bonus_round_id`. Wins build up, and the aggregate is granted at the finish. Your user display should present the number of free spins remaining and the live expanding symbol, maintaining the player updated.

Payment Integration and Reporting of Transactions

Precision in finances is crucial. The Book of Dead API does not handle real money. It only computes win amounts. Your platform must remove the stake before calling the spin endpoint, then apply the winnings after you get and confirm the result. This needs solid, atomic transaction logic on your backend to prevent 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 track `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 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 checks that your financial records align with the provider’s logs, creating a clear audit trail.

Error Handling and Compliance for the UK Market

Good 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 handle before the request), `SESSION_EXPIRED`, and `BET_LIMIT_EXCEEDED`. Your code must process these smoothly, perhaps by redirecting 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 terminate the game session right away and take the player to a secure, non-gambling part of your site. Documenting these events for your compliance team is required. The same goes for age verification failures; gameplay must stop immediately.

Implement using a circuit breaker pattern for API calls. If you experience several timeouts or server errors (5xx statuses) in a row, your system should back off and fail gracefully, maybe showing a maintenance message. This enhances the user experience and prevents your servers from overloading. Set up monitoring to alert your tech team if 4xx or 5xx error rates rise, so they can investigate quickly.

Simulation and Testing in a Test Environment

Never go live without extensive testing in the sandbox. This environment emulates 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 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 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.