UK engineers and platforms who want to add the Book of Dead Slot Book Of Dead to their systems need comprehensive API documentation to commence. This guide covers the Book of Dead slot API. It outlines the routes, data types, and how to configure it, all with the UK’s regulated market in mind. You’ll discover about authentication, testing spins, and controlling the game’s famous Expanding Symbol function. The aim is a dependable, legally valid setup.
Understanding the Book of Dead API Structure
The Book of Dead slot API is a REST-based service that uses JSON for transmitting and accepting data. Developed for high uptime, it keeps players entertained even during peak periods like major football matches. The architecture separates the game logic server from the client-side presentation. This split assures 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 initiates sessions and sends player actions. An API gateway takes these requests and directs them to the right game service. For UK operators, this structure facilitates the audit trails and data segregation the Gambling Commission requires. Comprehending this flow assists with debugging and incorporating custom features like tournaments or special promotions.
The API is stateless. Every request must contain its own authentication and context. This method aids scalability and dependability, enabling the service to handle traffic spikes. To maintain things smooth for users, even with network hiccups, you should add retry logic and connection pooling on your end.
Verification and Secure Session Setup
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 communication 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 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 enables the game link with timeout and limit functions. The response gives 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 confirm data hasn’t been modified. This step is essential for legal UK operation and safeguards both you and the player from interference.
Core Gameplay Endpoints: Spin and Result
The main endpoint for play is `/game/spin`. A POST request here 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 must check the player has adequate funds before calling the API, because the API does not handle wallet balances.
The spin response returns a detailed JSON object. It holds 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. 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 features required compliance fields. These are a `spin_timestamp` in UTC, a unique `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 synchronously as soon as you get the response, so nothing gets lost.
Handling the Bonus Spins Bonus and Growing Symbol
When the Free Spins round triggers, a separate sequence commences. The original base game spin result marks the start. Your client then sends `/bonus/initiate` with the `round_id` from that spin. This returns the bonus details: how many free spins were given and, most importantly, the randomly chosen `expanding_symbol` for this game.
The Expanding Symbol is what turns Book of Dead exciting. During free spins, one normal symbol changes into an expanding wild. If this symbol appears, it expands to fill the full reel, producing bigger wins. The API answer for each free spin clearly says if an expansion occurred and the win factor that ensued. Your visual should display this expansion distinctly to reflect the game’s layout and what players expect.
You execute each free spin with a call to `/bonus/spin`. The run goes on until all granted spins are used up. The API monitors the bonus round status, so you only require to submit the `bonus_round_id`. Wins accumulate, and the aggregate is granted at the conclusion. Your user display should display the quantity of free spins available and the active expanding symbol, ensuring the player aware.
Financial Integration and Reporting of Transactions
Precision in finances is critical. The Book of Dead API does not touch real money. It only determines win amounts. Your platform must subtract the stake before triggering the spin endpoint, then add the winnings after you receive and confirm 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 deposit this amount to the player’s balance. UK operators also need to track `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 query it with a date range or a specific `round_id` to retrieve a signed record of all transactions. UK licensees typically perform a daily reconciliation with this data. It verifies that your financial records line up with the provider’s logs, establishing a clear audit trail.
Error Management and Compliance for the UK Market
Proper error handling ensures stability. The API utilizes 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 gracefully, perhaps by sending the player to a deposit page or describing 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 respond with a `PLAYER_SUSPENDED` error. Your integration must terminate the game session right away and move the player to a protected, non-gambling part of your site. Logging these events for your compliance team is mandatory. The same applies for age verification failures; gameplay must cease immediately.
Think about using a circuit breaker pattern for API calls. If you encounter several timeouts or server errors (5xx statuses) in a row, your system should stop trying and fail gracefully, maybe showing a maintenance message. This enhances the user experience and stops your servers from overloading. Establish monitoring to warn your tech team if 4xx or 5xx error rates climb, so they can look into quickly.
Simulation and Modeling in a Sandbox Environment
Never go live without extensive 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 allows 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 prioritize 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 regulatory requirement.
The sandbox also includes tools to force specific outcomes, like initiating a bonus or a losing spin. This is extremely 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 consistently, especially before you update your platform or when a new API version is released.