Skip to main content

Connect a game provider yourself

Each game talks to its provider through an agent account: the account you hold with the game company. You can save those credentials, test them with a real test player, and switch a game on from the admin tool. Nobody needs to edit a setup file or ask for a deploy.

This guide is for Penguin Sweeps and Emma Sweeps. Both use the same admin tool and the same screens. The screenshots come from the Penguin practice view.

There are two jobs:

  • Part A. Connect or change the credentials of a game that is already in the list.
  • Part B. Add a brand new game of your own.

Before you start​

  • You must be a super admin to save credentials, run tests, add games or switch them on. Other staff can look but not change.
  • Open Platform in the left menu. If you do not see Game definitions with an Add game button, Connect is switched off for this brand or your role is not super admin. Ask whoever gave you access.
  • Have your agent username, agent password and the provider's API address from the game company.
  • You need a tester, a test player account, to run the full test. See Testers and admin accounts if you need to create one. The full test moves 1 credit into the game and back out, from that tester's existing wallet. Choose a tester who already has a little balance.

What you will see on Platform​

Platform opens a page with All games and Needs attention tabs. At the top is Game definitions, a table with the columns Game, Family, Origin, State and Revision. Below it is a card for each game.

The Game definitions table on Platform with the Add game button

  • Family is the kind of provider connection the game uses. It decides what credentials the game needs.
  • Origin is seed for games that came with the system and custom for games you added.
  • State is draft, verifying or live.
  • Only custom rows have an Edit button. Seed games already have their family and settings. You only change their credentials.

Part A. Connect or change credentials for a game in the list​

  1. Open Platform.
  2. Find the game's card. Press Manage API. If the game has no saved credentials yet, the button says Connect API.
  3. A window opens called Connect followed by the game's name and API, for example Connect Fire Kirin API.

The Connect Fire Kirin API window

The window has these parts, from top to bottom:

Connection. It shows Configured · API On or Not set up. The button Pause API calls stops the app from calling this provider. You must pause before you can check or save credentials. The note says so: Pause API calls before checking or saving these settings. Existing transfers remain available for verification.

Under it, Turn API back on after pausing lets you pick Until I turn it on, 15 minutes, 30 minutes, 1 hour, 2 hours or Custom minutes. A timer is the safest choice: if you forget, the API comes back on by itself.

Credentials. For example Agent username and Agent password. Saved secrets stay hidden. Use Replace to type a new value, Compare to check a value you hold against the saved one, and Keep saved to undo a replace. The exact fields depend on the game's family, so type what the form asks for. Each empty field shows an example under it.

API endpoint. The address the app calls. It starts as the setup address. Override lets you set a different one, and Use setup endpoint returns to the original. Endpoints must use HTTPS. If a provider only offers plain HTTP, the window warns you that credentials travel unencrypted.

Full API test. Choose a Test account (a tester) and a Test game, then press Run full test. It uses the saved connection and moves 1 credit in and out.

API capability test. Shows the results of the check, step by step. Saving stays separate.

Why are you changing it? Pick one: Set up this game, Replace credentials, Update API endpoint, Routine check or Other. If you pick Other, add a short note.

The usual order​

  1. Press Pause API calls.
  2. Press Replace next to each credential you are changing, and type the new value.
  3. Choose the reason, for example Replace credentials.
  4. Press Run API check. The app tries the new values with the provider. Read every result.
  5. If the check is good, press Save connection.
  6. Press Turn API on (or let the timer do it).
  7. Under Full API test, choose the Test account and Test game, and press Run full test. Confirm if asked.
  8. Read the results. A full pass means a real credit went in and out.

If the check fails, nothing is saved. Fix the value and run the check again. Check credentials is a quick check of just the saved credentials.

Part B. Add a new game of your own​

Use this when you have a new provider game that is not in the list.

1. Create the draft​

On Platform, press Add game. A window called Add game opens. It shows the five steps: 1. Create draft, 2. Choose family, 3. Credentials, 4. Live test, 5. Activate.

The Add game window

Fill in:

FieldWhat to put in it
Provider codeA short lowercase code that identifies the game, for example mygame. Choose it carefully, because other settings refer to it.
Username part (optional)Up to 2 characters used in the usernames made for players.
Display nameThe name staff see.
API base URLThe provider's API address. It must be HTTPS, on a public address, and on port 443, 8033, 8443, 8580 or 8781.
Panel URLThe provider's own back office website. It is behind the Open provider panel buttons.
Catalog nameThe name players see.
Logo URLA web address of the game's logo.
ReasonA short note for the audit trail.

Press Create draft. The new game appears in Game definitions with Origin custom and State draft.

2. Choose the family and settings​

Press the Edit button on its row (it says Edit and the game's name). A window called Edit followed by the game's code and definition opens:

  • Family: choose the connection family your provider uses. Under it, the fixed credit scale for that family is shown. If you are not sure which family fits, ask the game company or your support contact before guessing.
  • Default game ID: the provider's own ID for the game, if it asks for one.
  • Visibility: hidden (nobody sees it), allowlist_only (only players you allow) or public (everyone). Leave it on hidden until the game is live and tested.
  • Type a Reason and press Save definition.

Changing the endpoint, family or game ID later needs a new live test before the game can be activated again.

3. Credentials and live test​

Still in the same window, find Credentials and live test and press that button. It opens the same Connect window as Part A. Follow The usual order above: pause, enter the credentials, Run API check, Save connection, Turn API on, then Run full test with a tester.

The full test must pass. It is what unlocks activation.

4. Activate​

Back in the definition window, find the Activate game section. It shows when the last qualifying test passed. If the Activate game button is grey, the line above it says why, for example that a live test is still needed or that the test is out of date.

  1. Press Activate game.
  2. Add a reason.
  3. Confirm.

Activation makes the game live and serves it according to its Visibility. Set Visibility to public when you are ready for all players to see it.

To take a game out of play, open it and press Suspend game. Suspending hides the game and stops new accounts and money moves for it. Nothing is deleted.

If something goes wrong​

What you seeWhat to do
No Add game buttonYou are not a super admin, or Connect is off for this brand.
The check says to pause API calls firstPress Pause API calls, then try again.
Run API check failsRead the failing step. Re-enter the credentials with Replace, check the endpoint address, and try again.
Run full test is greyChoose both a Test account and a Test game. The tester needs an existing balance.
Activate game is greyRead the line above it. Usually the full test must pass first, or it is older than allowed and must be run again.
The window offers Review latest settings or Check original requestSomeone else saved at the same time, or the answer to your save was lost. Use the button before you save again.
Players cannot open a gameSee A game won't launch and needs an emergency fix.