UK developers and platforms who want to integrate the book of dead slot to their platforms need comprehensive API documentation to start. This guide covers the Book of Dead slot API. It details the interfaces, data structures, and how to configure it, all with the UK’s regulated market in mind. You’ll find out about authentication, testing spins, and handling the game’s iconic Expanding Symbol feature. The objective is a dependable, legally sound integration.
Grasping the Book of Dead API Structure
The Book of Dead slot API is a REST-based service that uses JSON for sending and receiving data. Developed for high reliability, it holds players involved even during busy periods like major football matches. The layout separates the game logic server from the client-side display. This split ensures that findings, like reel stops and bonus triggers, are arbitrary and managed securely on the backend.
In a typical integration, your platform is the client. It initiates sessions and transmits player actions. An API gateway takes these requests and channels them to the right game service. For UK operators, this framework supports the audit trails and data separation the Gambling Commission demands. Comprehending this sequence 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 promotes 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.
Security and Safe 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 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 breaking a player’s session.
To initiate 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 connect with timeout and limit capabilities. The response returns 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 validate these signatures with our public key to confirm data hasn’t been modified. This step is vital for legal UK operation and secures both you and the player from tampering.
Core Gameplay Endpoints: Spin and Result
The primary endpoint for play is `/game/spin`. A POST request to this endpoint executes a single spin at the player’s selected stake. The request must include the `game_session_token`, the `stake` in GBP, and an elective `feature_buy` flag if that is available. Your system must check the player has sufficient funds before calling the API, as the API does not process wallet balances.
The spin response comes as a detailed JSON object. It includes a `reel_stops` array displaying each reel’s position and a `symbols_matrix` for your client to animate. The `winning_lines` array details any payline wins, listing the line number, symbol, and payout. Critically, it indicates if the Free Spins bonus round started, which occurs when three or more Book scatter symbols appear anywhere.
For the UK market, the response includes required compliance fields. These comprise a `spin_timestamp` in UTC, a unique `round_id` for audits, and the `total_payout`. You need to store this data indefinitely for UKGC reporting and any customer disputes. A good practice is to log it synchronously as soon as you get the response, so nothing goes missing.
Processing the Bonus Spins Reward and Enlarging Symbol
When the Free Spins bonus starts, a different sequence begins. The original base game spin reply marks the start. Your client then requests `/bonus/initiate` with the `round_id` from that spin. This provides the bonus details: how many free spins were granted and, most crucially, the randomly picked `expanding_symbol` for this round.
The Expanding Symbol is what turns Book of Dead exciting. During free spins, one regular symbol changes into an expanding wild. If this symbol lands, it extends to fill the whole reel, producing bigger wins. The API answer for each free spin clearly states if an enlargement took place and the win multiplier that followed. Your graphic should show this spread distinctly to reflect the game’s style and what players look for.
You perform each free spin with a command to `/bonus/spin`. The sequence continues until all given spins are used up. The API monitors the bonus round status, so you only require to send the `bonus_round_id`. Wins accumulate, and the aggregate is granted at the end. Your user display should show the number of free spins available and the active expanding symbol, keeping the player aware.
Transaction Integration and Financial Reporting
Precision in finances is essential. The Book of Dead API does not handle real money. It only calculates win amounts. Your platform must subtract the stake before triggering the spin endpoint, then add the winnings after you receive and validate the result. This needs strong, 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 record `total_stake` and `total_wins` per player session to work out Gross Gambling Yield for regulatory reports.
We supply a `/transactions/history` endpoint for reconciliation. You can fetch it with a date range or a specific `round_id` to pull a signed record of all transactions. UK licensees typically run a daily reconciliation with this data. It verifies that your financial records align with the provider’s logs, building 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 are `INSUFFICIENT_BALANCE` (which you should handle before the request), `SESSION_EXPIRED`, and `BET_LIMIT_EXCEEDED`. Your code must process 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 need attention. If a player’s self-exclusion or timeout triggers during a game, the API might return a `PLAYER_SUSPENDED` error. Your integration must terminate the game session right away and take the player to a protected, non-gambling part of your site. Recording these events for your compliance team is required. The same goes for age verification failures; gameplay must halt immediately.
Implement 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 degrade gracefully, maybe presenting a maintenance message. This boosts the user experience and stops your servers from overloading. Configure monitoring to alert your tech team if 4xx or 5xx error rates increase, so they can investigate quickly.
Testing and Simulation in a Test Environment
Never go live without comprehensive testing in the sandbox. This environment mirrors 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 concentrate on 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 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 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 thorough automated test suite for these scenarios. Run it frequently, especially before you update your platform or when a new API version is released.