Starter kit integration
This guide applies to API integration. Hosted merchants do not deploy the kit. Configure Game integration settings in the partner dashboard. For installation and database initialization, see site/docs/deployment.md in the delivery package. Download the kit from Templates & tools.
1. Prepare your site and application
Deploy your site and independent database. Ensure the provider can reach your callback. Create an API app and apply for access.
| Application field | Value |
|---|---|
| Server IP | One IPv4 or IPv6 outbound address used by the partner server, not the administrator's browser IP |
| Callback URL | Full reachable URL, e.g. https://operator.example/callback |
| Application notes | Integration purpose and information needed for review |
The kit serves /callback on callback_listen. With a domain and reverse proxy, forward /callback to that listener. A working admin page does not prove callback connectivity. The kit does not infer public domains, outbound IPs or proxy settings.
See Apps and access applications.
2. Enter app credentials
After approval, open Applications → your app → Sandbox and copy credentials. In the partner dashboard, open Game integration settings:
| Platform value | Partner dashboard field | Notes |
|---|---|---|
| API endpoint | API base URL | Full base URL, not the portal or dashboard URL; do not append /api/v1 |
| code | Partner code | Copy the full value including code_; do not enter the literal word code |
| secret | secret | Use the current secret belonging to that code and update it after rotation |
All three values must belong to the same app. Use the game API endpoint, not the portal URL.
3. Test and save
Test connection authenticates with the form values and validates authentication. Success does not save settings.
Test and save performs the same checks, then saves and immediately uses the settings without restarting the site. Endpoint, code and secret are editable.
Passing only proves authentication, not callbacks, game servers or browser networking.
4. Verify games and callbacks
- Create a dedicated test player and load the game list.
- Launch a game and verify the browser opens the returned URL.
- Complete a test settlement and exit; inspect game records, wallet ledger and callbacks.
- Confirm callback success and matching balances. Never use real players for destructive tests.
5. Troubleshooting
| Symptom | Checks |
|---|---|
| Timeout or connection failure | Check endpoint, port, routes and firewall from the partner server |
| IP allowlist rejection | Compare the actual connection IP seen by the game entry with the registered IP; browser IPs and forged headers do not substitute |
| Authentication failure | Check approval and enabled state, full code, current secret and server clock |
| Authentication passes but games fail | Inspect catalog and launch responses and browser connectivity to game URLs and WebSockets |
| Games launch but callbacks fail | Check full callback URL, /callback proxy target, callback port, current secret and callback records |
Allowlist and secret changes take effect after runtime configuration refresh, usually within seconds. See Authentication and Callbacks and settlement.
6. Maintenance
Changing the callback URL or server IP in this console updates the selected app's active configuration. Do not enter the callback URL as the partner API base URL.
After secret rotation, update the partner settings and select Test and save. Follow Inbox notifications when endpoints change.