UK engineers and operators who want to integrate the book of dead payout slot to their platforms need comprehensive API documentation to start. This guide describes the Book of Dead slot API. It outlines the interfaces, data structures, and how to implement it, all with the UK’s regulated market in mind. You’ll learn about verification, testing spins, and managing the game’s famous Expanding Symbol feature. The goal is a dependable, legally valid setup.
Grasping the Book of Dead API Architecture
The Book of Dead slot API is a RESTful service that uses JSON for transmitting and receiving data. Designed for high availability, it maintains players engaged even during heavy periods like major football matches. The design divides the game logic server from the client-side presentation. This split ensures that outcomes, like reel stops and bonus triggers, are unpredictable and handled securely on the backend.
In a common implementation, your platform is the client. It begins sessions and transmits player actions. An API gateway receives these requests and routes them to the appropriate game service. For UK operators, this structure supports the audit trails and data isolation the Gambling Commission demands. Grasping this sequence helps with debugging and introducing custom features like tournaments or special promotions.
The API is stateless. Every request must carry its own authentication and context. This approach promotes scalability and stability, enabling the service to handle traffic spikes. To keep things seamless for users, even with network problems, you should add retry logic and connection pooling on your end.
Security and Protected Session Start
Safety comes first. The Book of Dead API uses OAuth 2.0 client credentials for authorisation. You must have 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 renew it automatically to avoid disrupting a player’s session.
To initiate a game session, send a POST request to `/session/start`. The payload needs 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 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 verify these signatures with our public key to confirm data hasn’t been changed. This step is crucial for legal UK operation and safeguards both you and the player from alteration.
Main Gameplay Endpoints: Spin and Result
The primary endpoint for play is `/game/spin`. A POST request to this endpoint places 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 should confirm the player has enough funds before calling the API, as the API does not handle wallet balances.
The spin response is a detailed JSON object. It includes a `reel_stops` array showing each reel’s position and a `symbols_matrix` for your client to render. The `winning_lines` array describes any payline wins, showing the line number, symbol, and payout. Crucially, it tells you 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 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 immediately as soon as you obtain the response, so nothing is lost.
Processing the Free Spin Feature and Growing Symbol
When the Free Spins feature activates, a different series starts. The original base game spin result indicates the start. Your client then requests `/bonus/initiate` with the `round_id` from that spin. This returns the bonus information: how many free spins were given and, most significantly, the randomly selected `expanding_symbol` for this session.
The Expanding Symbol is what makes Book of Dead exciting. During free spins, one standard symbol converts into an expanding wild. If this symbol lands, it extends to fill the full reel, producing bigger wins. The API response for each free spin plainly states if an expansion occurred and the win rate that followed. Your graphic should display this enlargement clearly to match the game’s style and what players expect.
You execute each free spin with a command to `/bonus/spin`. The sequence goes on until all given spins are used up. The API monitors the bonus round state, so you only need to send the `bonus_round_id`. Wins accumulate, and the aggregate is awarded at the end. Your user interface should show the count of free spins available and the current expanding symbol, keeping the player informed.
Financial Integration and Transaction Reporting
Financial accuracy 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 receive and verify the result. This needs 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 credit 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 offer a `/transactions/history` endpoint for reconciliation. You can query it with a date range or a specific `round_id` to obtain a signed record of all transactions. UK licensees typically run a daily reconciliation with this data. It verifies that your financial records match with the provider’s logs, building a clear audit trail.
Error Management and Regulatory Compliance for the UK Market
Effective 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 are `INSUFFICIENT_BALANCE` (which you should catch before the request), `SESSION_EXPIRED`, and `BET_LIMIT_EXCEEDED`. Your code must handle these smoothly, 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 stop the game session right away and move the player to a secure, non-gambling part of your site. Recording these events for your compliance team is required. The same holds true for age verification failures; gameplay must cease immediately.
Implement using a circuit breaker pattern for API calls. If you see several timeouts or server errors (5xx statuses) in a row, your system should back off and handle failure smoothly, maybe displaying a maintenance message. This improves the user experience and stops your servers from overloading. Configure monitoring to warn your tech team if 4xx or 5xx error rates rise, so they can diagnose quickly.
Trialing and Simulation in a Test Environment
Never go live without extensive testing in the sandbox. This environment reflects 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 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 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 regulatory requirement.
The sandbox also includes tools to force specific outcomes, like activating 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.