API keys are powerful and provide privileged access that developers use to interact with the data in their SquadCast account, typically through backend code. They should be kept secret and only be used with other trusted apps because they provide access to create, modify, and delete data in your SquadCast account.
How to create a new API Key
- Navigate to your account settings and select the Developers tab within the left side navigation. Please note that only the Organization owner has access to the Developers tab to access an API key.
- Click the Create API Secret Key button.
- Input the Key Name, then click Confirm.
When choosing a Key Name, we recommend the following:
- Using the name of the trusted app, you are using the Key with.
- Creating one Key per trusted app. This will allow you to revoke them per trusted app if needed in the future.
API Key options
Here are the options available to you within the API Keys section of your account settings:
- Click the Reveal button to view any of your API Secret Keys.
- Click the
Manage API Key button and select:
- Copy to Clipboard to copy any of your Keys to your clipboard.
- Revoke Access to block any apps from using the Key.
- Reactivate to allow apps to use a revoked Key again.
- Apply Backwards Compatibility to specify a Show and allow your Key to work with apps that don't support multi-step factorization.
- Click the View API Docs button to access full developer documentation for the SquadCast API.
This is a fallback option for integrations which are unable to use multi-step factorization. It allows you to pick which Show to manage. We will always attempt to respect the Show that you pass in the API routes. If no Show is specified we will default to your first Show in your Organization.