Ce qu’est une clé
Une clé est ce qu’un système présente chaque fois qu’il appelle l’API, pour que votre espace de travail sache qu’il en a le droit. Créez une clé par système : si l’une est perdue, vous la supprimez sans arrêter les autres.
Clés API liste vos clés : pour chacune, son Nom, sa valeur masquée sauf ses premiers caractères, et son Accès, Accès complet ou Limitée. Total, à côté du titre, indique combien il y en a.
Ajouter une clé
Sur Clés API, appuyez sur Ajouter une clé API.
La fenêtre Ajouter une nouvelle clé API s’ouvre.
Donnez un Nom à la clé, par exemple celui du système qui l’utilisera.
Sous Accès, gardez Accès complet, ou choisissez Limiter ce que cette clé peut faire.
Voir Ce qu’une clé peut faire ci-dessous.
Appuyez sur OK.
La fenêtre Votre nouvelle clé API affiche la clé et l’Adresse de base de l’API, chacune avec Copier.
Copiez la clé, placez-la dans les réglages secrets de votre système, et appuyez sur Je l’ai enregistrée.
Elle n’est plus affichée ensuite. Si elle est perdue, donnez une nouvelle valeur à la clé.
Ce qu’une clé peut faire
| À l’écran | À quoi cela sert |
|---|---|
| Accès complet | Tout ce que fait l’API, aujourd’hui et au fil de ses évolutions. Le lancement, la publication et l’activation attendent toujours un administrateur. |
| Limiter ce que cette clé peut faire | Seulement ce que vous cochez. La clé le garde pour de bon, et n’obtient jamais ce qui est ajouté à l’API plus tard. |
La liste d’une clé limitée est regroupée selon ce sur quoi elle agit : Boîte de réception, Audience, Messagerie, Automatisation, Ventes, Espace de travail et Développeur. Pour chaque élément, comme Contacts ou Modèles, vous cochez ce que la clé peut en faire, par exemple Lire ou Écrire. Tout sélectionner coche un groupe entier. Chaque ligne indique ce qu’elle permet.
- Ce qui est marqué Approbation d’un administrateur ne peut jamais qu’être demandé : un administrateur approuve d’abord chaque demande.
- La lecture des messages est marquée Données personnelles : c’est lire les propres mots de vos clients. Ne la donnez qu’à un système à qui vous confiez leurs conversations.
- Ce que votre formule n’inclut pas est grisé, et l’indique. Les réservations nécessitent le CRM : elles indiquent Nécessite le CRM quand votre espace de travail ne l’a pas.
Une clé ne modifie jamais un consentement, une désinscription ni un numéro de téléphone.
Renommer, renouveler ou supprimer une clé
Le crayon à côté du nom d’une clé la renomme. Le menu au bout de sa ligne propose le reste :
| À l’écran | À quoi cela sert |
|---|---|
| Nouvelle valeur | Donne une nouvelle valeur à la clé, affichée une seule fois. L’ancienne cesse aussitôt de fonctionner : chaque système qui l’utilise a besoin de la nouvelle. |
| Supprimer | La clé cesse aussitôt de fonctionner, définitivement. Les points de terminaison webhook créés par son intermédiaire sont désactivés. |
Donnez une nouvelle valeur à une clé, ou supprimez-la, dès que vous pensez que quelqu’un d’autre pourrait l’avoir.
Bon à savoir
- Un espace de travail a 20 clés au plus.
- Une clé est conservée sous une forme qui ne peut pas être relue : c’est pourquoi elle n’est affichée qu’une seule fois.
- La façon dont un système utilise sa clé, et le nombre d’appels qu’il peut faire, se trouvent dans le guide du développeur.