Clés API développeurs

Paramètres, section Clés API développeur (/app/settings#developer). Propriétaires et administrateurs uniquement. Une clé permet à votre propre logiciel d’appeler l’API publique OmniBrand avec l’en-tête Authorization : Bearer ob_live_...

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

1. Taper un nom dans Nom de la clé (ex. bot CI), jusqu’à 60 caractères, afin de savoir plus tard ce qui l’utilise.
2. Choisir lecture seule (lecture des données) ou lecture + écriture (qui crée et modifie aussi des choses).
3. Cliquez sur Créer une clé.
4. Une case jaune affiche « Clé API (copier maintenant - affichée une seule fois) : » et la clé complète. Copiez-la 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 : émet une nouvelle clé avec le même nom et la même portée, et ne l’affiche qu’une fois. L’ancienne clé continue de fonctionner pendant 24 heures pour que vous puissiez basculer votre intégration, puis elle s’arrête. D’ici là, elle reste dans la liste, non barrée, avec « L’ancienne clé fonctionne jusqu’au {date and time} » et un bouton Révoquer. - Révoquer : arrête la clé immédiatement. Cela fonctionne aussi sur une ancienne clé pendant ses 24 heures après 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.

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

• « Cette clé API a expiré. Renouvelez-la sous Paramètres > Clés API développeur. » : les clés sont valables un an. Cliquez sur Renouveler sur la clé dans Clés API développeur (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.

Liés

• Rôles et permissions
• Page des Réglages