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. 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.
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
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.
Limites de débit
The API is rate-limited to ensure service reliability and performance. 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.