Getting Started

This page walks you through the three integration methods, a step-by-step setup checklist, and the environment URLs you will need.

Choose your integration method

Unity games

Best for: Unity 2022.3+ projects, Android and iOS Time to integrate: about 30 minutes

Install the PlaySuper Unity SDK, initialize it with your API key, and call two methods: one to distribute coins and one to open the store:

// Pass true while you test with a test key; omit it for production.
PlaySuperUnitySDK.Initialize("YOUR_API_KEY", true);
PlaySuperUnitySDK.Instance.DistributeCoins(coinId, amount);
PlaySuperUnitySDK.Instance.OpenStore();

Follow the full walkthrough in the Unity SDK Guide.

WebView (any mobile app)

Best for: React Native, Flutter, native Android or native iOS apps Time to integrate: about 1 hour

Load the PlaySuper store in a WebView, pass the player's credentials as query parameters, and wrap it in your own screen with a close button. The WebView Integration guide walks through the complete flow with ready-to-use snippets for Kotlin, Java, Swift, React Native and Flutter.

Direct API integration

Best for: apps that need a fully custom rewards UI Time to integrate: 2 to 4 hours

Use the REST API directly to manage players, distribute coins, list rewards and process purchases, then build your own frontend on top. See the API Reference for all available endpoints.

Step-by-step setup

Step 1: Create your account and game (5 min)

Sign in to the PlaySuper Console, create your organization and game. The game comes with a test key for the sandbox environment. The Console Setup Guide walks through each screen.

Step 2: Create a coin and link it to your game (5 min)

Open the Coins section in the console. Create a coin, set its conversion rate (how much real-world value one coin represents), and copy the coinId. You will pass it to every distribute or purchase call.

Then link the coin to your game from the game's page in the console. Distribute and reward calls fail for unlinked coins. Organization-wide coins are linked to all your games automatically. See Console Setup: Link the coin.

Step 3: Integrate (30 to 60 min)

Pick the method that matches your app (Unity SDK, WebView or REST API) and follow the corresponding guide linked above. Use your test key and the development URLs below.

Step 4: Validate and go live (1 to 2 hrs)

In the sandbox, verify coin distribution, store opening and reward redemption. Then open your game's Integration page in the console and run Validate integration. Once validated, the console issues your live key. Swap it into your build (and, for WebView and REST, switch to the production URLs) to go live.

API keys and environments

Every game has one API key per environment, and the key decides which environment answers you.

A key sent to the other environment's host returns 401 Invalid API key. The same key is used by every PlaySuper API: the REST API, webhooks (where it is sometimes called a studio key) and the Gift Card API (where it is called client_id). See API keys in the API Reference for the full glossary.

In the Unity SDK you do not set a URL. Initialize("YOUR_API_KEY", true) targets the development environment for your test key; Initialize("YOUR_API_KEY") targets production for your live key.

Environments

Development (sandbox)

Production

United States

PlaySuper runs a separate, fully independent environment for the US region. Games integrating for a US audience register on the US console and call the US API:

Keep in mind:

• Registrations do not carry over between regions. An organization, game or API key created on the standard console does not exist in the US environment (and vice versa). Complete the Console Setup steps again on the US console.
• Credentials are region-specific. The API key and coinId you generate on the US console only work against the US environment; using them with the India endpoints returns 401 Unauthorized.
• WebView and REST integrations use the US base URL and store URL above in place of the India ones. Everything else in the guides applies unchanged.
• Unity SDK integrations do not configure a URL. The SDK routes each request to the region matching the player's current IP, so a game registered in both regions initializes with the key for the region the player is in.
• Serving both audiences? Register your game in each region and route players to the right credentials based on their region.

Next steps