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 de administración admite operaciones de creación, lectura, actualización y eliminación para la mayoría de los elementos de Omny, incluidas redes, programas y otros objetos.
Omny Studio también proporciona una API de consumidor independiente de solo lectura adecuada para aplicaciones móviles y sitios web. Para obtener más información, consulte API de consumidor.
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
Documentación de API V0: https://api.omnystudio.com/docs/management-api-v0
Documentación de API V1: https://api.omnystudio.com/docs/management-api-v1
Administrar claves de API
Las solicitudes a la API de administración de Omny Studio requieren una clave de API. Puede crear, ver, editar y revocar claves de API en Configuración de la organización > Claves de API. Su cuenta Omny Studio necesita el permiso Administrar claves de API .
Puede asignar permisos a una clave de API en los niveles de organización, red o programa.
Asigne solo los permisos y los accesos necesarios
Para evitar problemas de seguridad, evite asignar permisos y accesos que la clave de API no necesita.
Tratar las claves de API como contraseñas
Nunca debe revelar ni publicar sus claves de API donde personas no autorizadas puedan encontrarlas. Omny le muestra la clave de acceso solo cuando la crea, no podrá recuperarla después de haberla creado.
Crear una clave de API
Vaya a Configuración de la organización > claves de API.
Seleccione Nueva clave de API.
En Nueva clave de API, rellene Nombre y seleccione Crear clave de API.
En Clave de API creada, seleccione Copiar al portapapeles, pegue y guarde la clave de API en un lugar seguro y, a continuación, seleccione Cerrar y administrar permisos.
En ¿Está seguro?, seleccione Aceptar para continuar.
Seleccione los permisos y el acceso que desea asignar a la clave API y, a continuación, seleccione Guardar cambios.
Editar una clave de API
Puede cambiar los permisos y el acceso de una clave de API. No puede cambiar su nombre y no puede acceder a la clave API en sí.
Vaya a Configuración de la organización > claves de API.
Busque la clave de API que desea editar.
Seleccione Editar permisos de clave de API.
En Edit API key permissions (Editar permisos de clave de API), cambie los permisos y el acceso y, a continuación, seleccione Guardar cambios.
Revocar una clave de API
Puede eliminar una clave de API para que la API de administración rechace las solicitudes que la utilizan.
No puede deshacer una clave de API revocada
Vaya a Configuración de la organización > claves de API.
Busque la clave de API que desea revocar.
Seleccione Revocar.
Para confirmar su decisión, seleccione Revocar clave de API.
Exportar detalles sobre las claves de API
Puede ver detalles sobre sus claves de API exportando un archivo CSV (valores separados por comas). Este archivo no contiene claves de API, solo información sobre ellas.
Vaya a Configuración de la organización > claves de API.
Seleccione Exportar CSV para descargar el archivo.
Abre el archivo CSV descargado en tu aplicación de hoja de cálculo.
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.