Omny Studio dispose d’un ensemble d’API de gestion pour permettre aux développeurs d’intégrer des systèmes de gestion de contenu tiers pour gérer le contenu dans Omny Studio. L’API de gestion prend en charge les opérations de création, de lecture, de mise à jour et de suppression pour la plupart des éléments d’Omny, y compris les réseaux, les programmes et d’autres objets.
Omny Studio fournit également une API grand public distincte en lecture seule adaptée aux applications mobiles et aux sites Web. Pour plus d’informations, consultez API grand public.
Les versions
Il existe deux versions de l’API de gestion, appelées V0 et V1. La V0 continue d’être prise en charge et ne sera pas supprimée, mais ne comportera plus de développement de nouvelles fonctionnalités.
Nous recommandons la V1 pour les nouveaux développements. Il présente un certain nombre de nouveaux terminaux, notamment des analyses de téléchargement et des rapports plus détaillés, des événements d’audit, ainsi que la gestion des utilisateurs, pour n’en citer que quelques-uns. Il présente également plusieurs propriétés pour les clips, les listes de lecture, les programmes et les réseaux qui n’étaient pas disponibles auparavant dans l’API V0 et qui n’étaient accessibles que via l’interface utilisateur.
Documentation
Documentation de l’API V0 : https://api.omnystudio.com/docs/management-api-v0
Documentation de l’API V1 : https://api.omnystudio.com/docs/management-api-v1
Gérer les clés d’API
Les demandes adressées à l’API de gestion Omny Studio nécessitent une clé API. Vous pouvez créer, voir, modifier et révoquer des clés API dans Paramètres de l’organisation > Clés API. Votre compte Omny Studio a besoin de l’autorisation Gérer les clés API.
Vous pouvez attribuer des autorisations à une clé API au niveau de l’organisation, du réseau ou du programme.
N’attribuez que les accès et autorisations nécessaires
Pour éviter les problèmes de sécurité, évitez d’attribuer des autorisations et des accès dont la clé API n’a pas besoin.
Traitez les clés API comme des mots de passe
Vous ne devez jamais révéler ou publier vos clés API là où des personnes non autorisées pourraient les trouver. Omny n’affiche la clé d’accès que lorsque vous la créez, vous ne pouvez pas la récupérer une fois que vous l’avez créée.
Créer une clé API
Accédez à Paramètres de l’organisation > Clés API.
Sélectionnez Nouvelle clé API.
Dans Nouvelle clé API, renseignez le Nom et sélectionnez Créer une clé API.
Dans Clé API créée, sélectionnez Copier dans le presse-papiers, collez et enregistrez la clé API dans un emplacement sécurisé, puis sélectionnez Fermer et gérer les autorisations.
Dans Êtes-vous sûr ?, sélectionnez OK pour continuer.
Sélectionnez les autorisations et accès à attribuer à la clé API, puis sélectionnez Enregistrer les modifications.
Modifier une clé API
Vous pouvez modifier les autorisations et accès d’une clé API. Vous ne pouvez pas modifier son nom et vous ne pouvez pas accéder à la clé API elle-même.
Accédez à Paramètres de l’organisation > Clés API.
Recherchez la clé API que vous souhaitez modifier.
Sélectionnez Modifier les autorisations de la clé API.
Dans Modifier les autorisations de la clé API, modifiez les autorisations et accès , puis sélectionnez Enregistrer les modifications.
Révoquer une clé API
Vous pouvez supprimer une clé API afin que l’API de gestion rejette les demandes qui l’utilisent.
Vous ne pouvez pas annuler la révocation d’une clé API
Accédez à Paramètres de l’organisation > Clés API.
Recherchez la clé API que vous souhaitez révoquer.
Sélectionnez Révoquer.
Pour confirmer votre décision, sélectionnez Révoquer la clé API.
Exporter les détails sur les clés API
Vous pouvez afficher des détails sur vos clés API en exportant un fichier CSV (valeurs séparées par des virgules). Ce fichier ne contient pas de clés API, mais seulement des informations les concernant.
Accédez à Paramètres de l’organisation > Clés API.
Sélectionnez Exporter CSV pour télécharger le fichier.
Ouvrez le fichier CSV téléchargé dans votre tableur.
Limites de débit
L’API est limitée en débit pour garantir la fiabilité et les performances du service. Les limites de débit sont appliquées à l’ensemble de l’organisation sur toutes les clés d’API. Vous pouvez trouver la limite de débit de l’organisation dans la page de paramètres des clés API d’Omny Studio.
Si vous avez besoin d’une limite d’API plus élevée, veuillez contacter l’assistance en indiquant la raison technique de cette augmentation.
CORS
Les requêtes CORS ne sont pas autorisées par défaut sur l’API de gestion pour des raisons de sécurité, car il n’est pas possible de sécuriser les clés d’API de gestion dans JavaScript côté client exécuté dans un navigateur Web.
Il existe un risque considérable que des acteurs malveillants récupèrent des clés d’API de gestion. Elles peuvent alors être utilisées pour créer, modifier et supprimer des données dans votre organisation.
Comme alternative, vous pouvez utiliser l’API grand public qui autorise les requêtes CORS.
Toutefois, si vous pensez que vos risques de sécurité sont limités et que vous souhaitez l'autorisation des requêtes CORS pour une clé API de gestion spécifique, veuillez contacter l'assistance.