API de gestion

Précédent Suivant

Gérez le contenu et intégrez des systèmes de gestion de contenu tiers

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 peut recevoir des autorisations avec les mêmes options qu’un utilisateur de l’organisation dans Omny Studio.

Omny Studio fournit également une « API grand public » distincte en lecture seule, adaptée à une utilisation dans des applications mobiles et des sites Web. Cliquez ici pour en savoir plus.

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

La documentation de l’API pour la V0 est disponible à l’adresse https://api.omnystudio.com/docs/management-api-v0. Pour la V1, elle est disponible à l’adresse https://api.omnystudio.com/docs/management-api-v1

Génération de clés API

  1. Cliquez sur le logo Omny Studio en haut à gauche du système pour afficher l'aperçu de votre organisation.

  2. Allez dans Paramètres de l’organisation dans la barre latérale gauche.

  3. Cliquez sur Clés API.

  4. Cliquez sur Nouvelle clé API comme dans la capture d’écran ci-dessous.

  5. Copiez la clé API, affichez-la en texte brut ou supprimez la clé à partir de l’écran ci-dessus.

Niveaux d’autorisation

La clé API sera visible dans la liste des utilisateurs de l’organisation et ses autorisations pourront être configurées de la même manière que n’importe quel utilisateur. Consultez un guide sur la configuration des autorisations des utilisateurs de l’organisation ici.

Limites de débit

Le débit de l’API est limité 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.