Adding a new API Integration

Before you can use the SubscribeStar API you need to add a new API Integration to your account

1. Navigate to https://www.subscribestar.com/profile/settings#oauth2_applications

2. Click the Add Integration button

3. You should set the Integration Type to Indie Game, and set the Redirect URL and Scopes to match your intended usage

   The value used in the Redirect URL field depends on how you plan to configure and use the plugin (below). You can edit this value at any time later if necessary.

   If you plan to handle everything within the game client, then the game client will expect the redirect at http://localhost:8080/login by default. This can be customized, though, for example to use something like http://localhost:9999/subscribestar

   If you plan to use your own web service to proxy the authentication, then the Redirect URL should point to your web server.

   By default, this plugin will request data which requires the subscriber.read and user.read scopes. If you intend to perform your own custom queries against the SubscribeStar API, you may need to enable additional scopes. In general, you should always only enable the minimum number of required scopes, don't just enable them all.

For any questions, help, suggestions or feature requests, please feel free to contact me at nbpsup@gmail.com