Omny Studio has a set of management APIs to allow developers to integrate third-party content management systems to manage the content in Omny Studio.
The API can be given permissions with the same options as an Organization user in Omny Studio.
Omny Studio also provides a separate read-only, "Consumer API", suitable for usage in mobile apps and websites, which you can read more about here.
There are two versions of the Management API which are called V0 and V1. V0 continues to be supported and will not be removed, but will no longer have any new feature development.
We recommend V1 for new development. It exposes a number of new endpoints including more detailed download analytics and reporting, audit events, as well as user management to name a few. It also exposes a number of properties for clips, playlists, programs and networks that were not previously available in the V0 API and were only accessiable via the UI.
Generating API keys
Click on the Omny Sudio logo on the top left of the system to view your Organisational view.
Go to Organization settings in the left sidebar.
Go to API Keys.
Click New API Key as in the screenshot below.
5. Copy the API Key, show the Key in plaintext, or revoke the key from the screen above.
The API Key will be viewable in the list of organization users, and its permissions can be configured in the same way as any user. See a guide to configuring organization user permissions here.
The API is rate limited to ensure service reliability and performance. Rate limits are applied organization-wide across all API keys. You can find the organization's rate limit in the API Keys settings page in Omny Studio.
If you require a higher API limit, please contact support with a technical reason for the increase.
There is considerable risk if bad actors retrieve a management API keys as it can be used to create, modify and delete data in your organization.
As an alternative you may consider the Consumer API which allows CORS requests.
However if you believe you have an exceptional use case where the security risks are mitigated and would like CORS requests to be allowed for a specific management API key, please contact support.