API de gestión

Anterior Siguiente

Gestionar contenido e integrar sistemas de gestión de contenido de terceros

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.

La API puede recibir permisos con las mismas opciones que un usuario de la organización en Omny Studio.

Omny Studio también proporciona una "API de consumidor" separada de solo lectura, adecuada para su uso en aplicaciones móviles y sitios web, sobre la que puede obtener más información aquí.

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

La documentación de API para V0 está disponible en https://api.omnystudio.com/docs/management-api-v0 y para V1 está disponible en https://api.omnystudio.com/docs/management-api-v1

Generación de claves de API

  1. Haga clic en el logotipo de Omny Sudio en la parte superior izquierda del sistema para ver la vista de la organización.

  2. Ve a Configuración de la organización en la barra lateral izquierda.

  3. Vaya a Claves de API.

  4. Haga clic en Nueva clave de API como en la captura de pantalla a continuación.

  5. Copie la clave de API, muestre la clave en texto sin formato o revoque la clave desde la pantalla de arriba.

Niveles de permisos

La clave API se podrá ver en la lista de usuarios de la organización y sus permisos se pueden configurar de la misma manera que cualquier usuario. Consulte una guía para configurar los permisos de usuario de la organización aquí.

Límites de velocidad

La API tiene una tarifa limitada para garantizar la confiabilidad y el rendimiento del servicio. 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.