Afin d'utiliser l'API de Yext, les administrateurs doivent d'abord obtenir un jeton d'authentification partagé. Les administrateurs de compte peuvent générer un jeton API en suivant les étapes ci-dessous.
Génération d'un jeton API
Désactiver un jeton API
Génération d'un jeton API
1. Dans la vue Administration, sélectionnez Settings (Paramètres) > Integrations (Intégrations). Ensuite, cliquez sur Generate Token (Générer un jeton).
2. Complétez les informations dans la fenêtre contextuelle. Ensuite, cliquez sur Générer.
-
Token Name (Nom du jeton) : indiquez à quoi il servira. Ce nom fournit du
contexte sur l'utilisation du jeton lorsqu'il est affiché dans la liste. -
Access (Accès) : sélectionnez Full Organization (Organisation complète) ou Single Workspace (Espace de travail unique).
- Si Full Organization est sélectionné, ignorez la sélection de Workspace Name (Nom de l'espace de travail).
- Si Single Workspace est sélectionné, recherchez et sélectionnez l'espace de travail approprié dans le menu déroulant Workspace Name (Nom de l'espace de travail).
- Scopes (Portées) : plusieurs portées peuvent être sélectionnées.
- Permissions (Autorisations) : sélectionnez Read/Write (Lecture/écriture) ou Read Only (Lecture seule).
3. Un nouveau jeton apparaît dans la liste API Tokens (Jetons API). Copiez la chaîne du jeton à l'aide du bouton Copy Token (Copier le jeton) sous l'onglet Action et enregistrez-la dans un emplacement sécurisé. Ce jeton servira à authentifier toutes les requêtes d'API.
Désactiver un jeton API
Veuillez garder à l'esprit que la désactivation d'un jeton le révoquera de manière permanente.
1. Dans la vue Administration, sélectionnez Paramètres > Intégrations.
2. Sélectionnez l'icône de crayon sous la colonne Action pour le jeton que vous souhaitez désactiver.
3. Sélectionnez le bouton Deactivate (Désactiver). Pour afficher le jeton API actuel, sélectionnez l'icône en forme d'œil (Afficher le jeton) à droite du jeton API.
L'entrée du jeton est déplacée vers le bas de la liste, où tous les jetons inactifs sont répertoriés avec un signe moins et grisés, indiquant que leur statut est Inactive (Inactif).
Pour plus d'informations, consultez la section Authentification du Guide du développeur. (Mot de passe : HearsayDocs)