Omny Studio tiene varias API de gestión que permiten a los desarrolladores integrar sistemas de gestión de contenido de terceros para administrar el contenido en Omny Studio. The Management API supports create, read, update, and delete operations for most items in Omny, including networks, programs, and other objects.
Omny Studio also provides a separate read-only Consumer API suitable for mobile apps and websites. For details, see Consumer API.
Versiones
Hay dos versiones de la API de administración que se denominan V0 y V1. V0 sigue siendo compatible y no se eliminará, pero ya no tendrá ningún desarrollo de nuevas características.
Recomendamos V1 para nuevos desarrollos. Expone una serie de nuevos puntos finales que incluyen análisis e informes de descarga más detallados, eventos de auditoría y administración de usuarios, por nombrar algunos. También expone una serie de propiedades para clips, listas de reproducción, programas y redes que antes no estaban disponibles en la API V0 y a las que solo se podía acceder a través de la interfaz de usuario.
Documentación
API V0 documentation: https://api.omnystudio.com/docs/management-api-v0
API V1 documentation: https://api.omnystudio.com/docs/management-api-v1
Manage API Keys
Requests to the Omny Studio Management API require an API key. You can create, see, edit, and revoke API keys in Organization Settings > API keys. Your Omny Studio account needs the Manage API Keys permission.
You can assign permissions to an API key at the organization, network, or program levels.
Assign only necessary access and permissions
To avoid security problems, avoid assigning permissions and access that the API key doesn’t need.
Treat API keys like passwords
You should never reveal or publish your API keys where unauthorized people may find them. Omny shows you the access key only when you create it, you can't retrieve it after you've created it.
Create an API Key
Go to Organization Settings > API keys.
Select New API key.
In New API key, fill in Name and select Create API key.
In API key created, select Copy to clipboard, paste and save the API key in a secure place, then select Close and manage permissions.
In Are you sure?, select OK to continue.
Select the permissions and access to assign to the API key then select Save changes.
Edit an API Key
You can change an API key's permissions and access. You cannot change its name and you cannot access the API key itself.
Go to Organization Settings > API keys.
Find the API key you want to edit.
Select Edit API key permissions.
In Edit API key permissions, change the permissions and access then select Save changes.
Revoke an API Key
You can delete an API key so that the Management API rejects requests that use it.
You cannot undo a revoked API key
Go to Organization Settings > API keys.
Find the API key you want to revoke.
Select Revoke.
To confirm your decision, select Revoke API key.
Export Details About API Keys
You can see details about your API keys by exporting a CSV (comma-separated values) file. This file does not contain API keys, only information about them.
Go to Organization Settings > API keys.
Select Export CSV to download the file.
Open the downloaded CSV file in your spreadsheet application.
Límites de velocidad
The API is rate-limited to ensure service reliability and performance. Los límites de velocidad se aplican en toda la organización en todas las claves de API. Puede encontrar el límite de velocidad de la organización en la página de configuración de Claves de API en Omny Studio.
Si necesita un límite de API más alto, póngase en contacto con el soporte técnico por un motivo técnico del aumento.
CORS
Las solicitudes CORS no están permitidas de forma predeterminada en la API de administración por razones de seguridad, ya que no es posible proteger las claves de API de administración en JavaScript del lado del cliente que se ejecuta en un entorno de navegador.
Existe un riesgo considerable si los malos actores recuperan claves de API de administración, ya que se pueden usar para crear, modificar y eliminar datos en su organización.
Como alternativa, puede considerar la API de consumidor que permite solicitudes CORS.
Sin embargo, si cree que tiene un caso de uso excepcional en el que se mitigan los riesgos de seguridad y desea que se permitan las solicitudes de CORS para una clave de API de administración específica, póngase en contacto con el soporte técnico.