The RMS Console offers essential tools to manage access to the RMS API, including API Keys and API Access credentials. API Keys grant complete API access, so ensure their protection. Use these credentials obtained from the RMS Console for a secure connection.
In this article:
RMS Console
RMS Console is a consolidated management interface for accessing and managing Ravnur applications. The RMS Console provides:
- Media workflow management capabilities
- Asset management
- Encryption policies assignment tools
- Live streaming controls, etc.
Locate your RMS Console at apps.ravnur.com and sign in.
API Key
This information provides security guidelines for system administrators managing API credentials in the RMS Console.
Review and create the API Keys:
1. Select the API Key Management tab in the RMS Console.
2. Review the API keys history display. Each RMS account has its own set of API keys.
The list shows each key's:
- Name
- Creation date
- Expiration date
- Creator
- Status ("Valid" unless expired)
Normally only the ‘default’ key is listed until additional keys are created.
3. To create a new key, select + Create API Key:
3.1. Provide a descriptive name
3.2. Select an appropriate expiration period
3.3. Click Create API Key
3.4. Copy the generated key immediately and store it securely
3.5. Check the confirmation box to acknowledge you've saved the key
If you need to replace a previous key (including the "default" key), you can delete the old key from this tab after creating a new key.
Warning! Deleting an API key will immediately break all existing integrations with RMS that use that key. Ensure you've updated all applications to use the new key before revoking.
API Access
API Access is a JSON that you can copy all necessary RMS connection credentials to be specified in your app configuration.
- RMS Subscription ID;
- RMS Resource Group Name;
- RMS Account Name;
- RMS API Endpoint;
- RMS API Key is represented as <API KEY>. Use your actual API key value for this placeholder.
Never share this configuration file containing your actual API key with unauthorized parties, post it online, or store it in unsecured locations.