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 secure connection, management, and rotation of your API Keys.
RMS Console
The RMS Console provides access to RMS account settings that you can manage. Once you connect a storage account, you can configure storage settings, endpoint hostnames, configure the video indexer and DRM through the console.
You may also find the option to migrate data from AMS API (please refer to the Complete Guide of Migration from AMS to RMS in case you haven’t completed this process).
Here is how to locate your console URL:
- On the Azure Portal, go to RMS Managed Application resource: Managed Applications center -> Marketplace Applications -> Find RMS Application and open it.
- Then click on "Parameters and Outputs".
-
Copy the "consoleURL" from the list of outputs and open it in a browser.
API Key
This information is aimed to guide system administrators on security parameters. Learn more about key rotation online.
To view and rotate your API account access keys:
- Press the "API Access" button next to your account in the RMS Console.
-
Your account access keys appear, along with the API Access for each of your accounts. You are also able to check the last rotation date of the API Key.
-
Select "Rotate keys" to change your access keys. As a result, the API Key is updated.
-
Replace the existing API key with the new one generated during key rotation in all the fields containing the previous API Key you used.
Warning! Generating a new API key will immediately break all existing integration with RMS that uses the old API key.
API Access
The screenshot above shows the JSON formatted credentials that are needed to connect to RMS.
- RMS Subscription ID;
- RMS Resource Group Name;
- RMS Account Name;
- RMS API Endpoint (https://{unique-string}.ravnur.net/);
- RMS API Key.
The format generated is specific to the AMS Explorer for RMS. You can use these values in your SDK or API calls to establish connection with RMS, although the field names may be different.