Accès API (pour les développeurs)

Paramètres → Intégrations (/app/settings/integrations), carte Accès API (pour les développeurs), en bas de la page. Propriétaires et administrateurs uniquement. « Connectez OmniBrand à vos propres systèmes, à Zapier ou à Make pour créer des publications, ajouter des contacts ou lire les statistiques automatiquement. » Une clé permet à votre propre logiciel d’appeler l’API publique d’OmniBrand avec l’en-tête Authorization: Bearer ob_live_… Le bas de la carte, Point de terminaison de l’API, affiche l’adresse à laquelle envoyer ces requêtes (« L’adresse à laquelle répond l’API publique. Envoyez-y chaque requête, avec l’une des clés ci-dessus. »). Les anciens liens vers /app/settings#developer ouvrent cette carte.

Les forfaits qui l’incluent

L’accès API fait partie des forfaits Agency et Enterprise. Avec Gratuit, Starter et Pro, et pendant l’essai Pro de 14 jours, la carte affiche seulement « L’accès API est disponible avec le forfait Agency. » avec un lien Voir les forfaits vers Forfait et utilisation ; il n’y a pas de formulaire de clé. Les cartes de forfait de Forfait et utilisation et de /pricing indiquent Accès API pour Agency et Enterprise.

Quand le forfait change

• Quand le compte passe à un forfait sans accès API (une rétrogradation, un remboursement ou la fin d’un essai), ses clés sont mises en pause : elles restent enregistrées et rien n’est supprimé, mais chaque appel fait avec elles est refusé avec « API access is available on the Agency and Enterprise plans. Upgrade under Settings > Plan & usage to use API keys. » (HTTP 403, code api_access_not_in_plan).
• Le propriétaire du compte reçoit un seul e-mail, Your API keys are paused (« Vos clés API sont mises en pause, car votre forfait n’inclut plus l’accès API… »), avec un bouton Voir les forfaits.
• Revenir à Agency ou Enterprise réactive les mêmes clés en moins d’une minute. Inutile d’en créer de nouvelles.
• Pendant la pause, les clés ne sont pas listées et ne peuvent être ni créées ni renouvelées. Pour arrêter une clé définitivement, repassez à un forfait qui inclut l’accès API et cliquez sur Révoquer, ou contactez le support.

Étape par étape : créez une clé

1. Tapez un nom dans Nom de la clé (par exemple CI bot), jusqu’à 60 caractères, pour savoir plus tard ce qui l’utilise. Sans nom (ou uniquement en espaces), Créer une clé ne crée rien et la case indique « Donner un nom à la clé, par exemple « Synchronisation du site web ». Les espaces avant et après le nom sont supprimés.
2. Dans les Portées de la clé, choisissez lecture seule (lecture des données) ou lecture + écriture (qui crée et modifie également des choses).
3. Cliquez sur Créer une clé.
4. Une case jaune affiche « Nouvelle clé pour « (nom) ». Copiez-la maintenant : elle n’apparaît qu’une seule fois. » et la clé complète, avec Copier (elle affiche alors Copié) et Je l’ai enregistrée, ce qui ferme la boîte. Copiez la clé maintenant et gardez-la en lieu sûr ; OmniBrand ne stocke qu’une empreinte digitale et ne pourra plus jamais la montrer.

La liste

Chaque touche indique son nom, les premiers caractères (ob_live_...), son champ d’application, la date d’utilisation pour la dernière fois (« utilisé ... » ou « jamais utilisé ») et « expire ... » avec sa date de fin.

• Renouveler : demande d’abord : « Renouveler «(nom)» (préfixe…) ? Vous obtenez immédiatement une nouvelle clé. La clé actuelle continue de fonctionner pendant 24 heures puis s’arrête : placez donc la nouvelle clé partout où l’ancienne est utilisée avant ce délai. » Cliquez sur Renouveler la clé pour continuer, ou sur Annuler. La nouvelle clé, avec le même nom et la même portée, s’affiche une seule fois dans le même encadré jaune. L’ancienne clé continue de fonctionner pendant 24 heures pour que vous puissiez basculer votre intégration, puis s’arrête. D’ici là, elle reste dans la liste, non barrée, avec « L’ancienne clé fonctionne jusqu’à [date et heure] » et un bouton Révoquer.
• Révoquer : demande "Révoquer la clé (nom) (préfixe…) ? Tout ce qui l’utilise cesse de fonctionner immédiatement, et une clé révoquée ne peut pas être réactivée." La fenêtre s’intitule Révoquer la clé ? ; cliquez sur Révoquer la clé pour arrêter la clé immédiatement, ou sur Annuler pour la conserver. Cela fonctionne aussi sur une ancienne clé pendant les 24 heures qui suivent un renouvellement : si vous avez renouvelé la clé parce qu’elle a fuité, cliquez sur Révoquer sur l’ancienne clé pour qu’elle s’arrête tout de suite. Les clés révoquées (et les clés renouvelées une fois leurs 24 heures écoulées) restent dans la liste, barrées, avec une étiquette rouge "Révoqué le (date)" sous le nom.

Qui possède une clé

• Une clé appartient à la personne qui l’a créée, et elle couvre les espaces de travail où cette personne est propriétaire ou administrateur au moment de la création.
• Elle ne fonctionne que tant que son créateur est encore propriétaire actif ou administrateur de tous les espaces de travail qu’il couvre. S’ils sont supprimés, rétrogradés ou si leur connexion est désactivée, les appels sont échoués avec « La personne qui a créé cette clé API n’administre plus ses espaces de travail. Demandez à un administrateur actuel d’émettre une nouvelle clé. »
• Vous voyez, ne faites roter et révoquer que les clés dont vous administrez vous-même les espaces de travail. Dans un compte avec plusieurs espaces de travail clients, l’administrateur d’un client ne peut pas voir les clés d’un autre.

Si quelque chose tourne mal

• « This API key has expired. Rotate it under Settings > Integrations > API access. » : les clés durent un an. Cliquez sur Renouveler sur la clé dans Accès API (pour les développeurs) (ou créez-en une nouvelle) et mettez à jour votre intégration.
• « Clé API invalide ou révoquée » : la clé a été révoquée, sa grâce de rotation de 24 heures terminée, ou elle a été copiée incomplètement.
• Une clé API ne peut pas créer, faire pivoter ou révoquer d’autres clés ; seule une personne connectée le peut.
• « This endpoint is not available to API keys » : cet appel est réservé à une personne connectée, quelle que soit la portée de la clé. Une clé ne peut jamais atteindre : les membres et les invitations (/workspaces/{id}/members, /workspaces/{id}/invitations, /invitations), la création, le renommage, l’archivage, le désarchivage ou la suppression d’un espace de travail, les webhooks sortants (/workspaces/{id}/webhooks), les exports, la chaîne d’approbation, les plannings de rapports, la connexion, la déconnexion ou la suppression d’un canal ou le changement de son propriétaire, le logo, le profil et l’onboarding de l’organisation, et tout ce qui se trouve sous /auth, /billing, /admin ou /tenant/api-keys. Faites-le dans l’application, connecté en tant que propriétaire ou administrateur. L'IA via une clé couvre le texte des publications, les idées, les images, les reformulations, les hashtags, le texte alternatif et le tri des messages, jusqu'à 10 appels par minute et 300 par jour par clé ("API key AI rate limit exceeded") ; la vidéo, AI Studio et les autres assistants IA sont réservés aux personnes connectées. Les tâches, sources et réglages de Market Watch, les bots et les réglages de l'espace de travail comme le tri automatique ne peuvent eux aussi être modifiés que par une personne connectée. Activer ou désactiver le support, modifier sa classification par IA et la lecture IA de Brand Health nécessitent aussi une personne connectée, et un rapport demandé avec une clé ne contient un résumé IA que s'il existe déjà.

Liés

• Forfaits
• Intégrations : webhooks sortants
• Rôles et permissions
• La page Paramètres