Authenticating with API Keys
The Regression Games platform provides the ability to generate API keys, which can be used to authenticate against our API. This is the recommended way to authenticate against our API when connecting external systems to Regression Games.
You can find the API Keys section near the bottom of your Regression Games account settings.
Generating an API Key
Enter a unique name for your key and then click Generate Key. API keys have an expiration date of 1 year.
Make sure to copy the generated key and store it somewhere safe. Once the success dialog is dismissed, you will never be able to see the generated value through the Regression Games web interface again!
Using an API Key
Once you have generated an API key, you can use it to authenticate against our API.
In the Unity SDK
If you just installed our core SDK, or have just opened your project with the SDK already installed,
then you may be greeted by a welcome prompt. Click the Set API Key button near the bottom of the prompt
to open the Regression Games settings window. If the welcome prompt isn't visible,
then access the settings window by navigating to Regression Games > Open Settings.
Paste your key into the RG API Key field, then close the project settings.
Sending API Requests
Include the key in the Authorization header of each request you send to our API.
HEADERS
Authorization: Bearer <API_KEY>
Revoking API Keys
You can remove API Keys at any time by deleting them from the API Keys section. Next to each key is a delete icon, which immediately revokes the key.