Guide d’authentification CLI Archbee
Présentation de l’authentification
La plupart des commandes de l’API Archbee CLI nécessitent :
- --api-key
- --doc-space-id
Exemple :
archbee search-docs --api-key YOUR_API_KEY --doc-space-id YOUR_SPACE_IDTypes de clés API
Clés API de l’espace
Les clés API de l’espace sont limitées à un seul espace de documentation.
Vous pouvez les générer à partir de :
Space Settings → API keysClés API d’équipe
Les clés API d’équipe commencent par :
abteam_Les administrateurs d’équipe peuvent les créer à partir de :
Settings → DeveloperLes clés API d’équipe peuvent accéder à plusieurs espaces.
Quand --doc-space-id est requis
La plupart des commandes nécessitent une valeur --doc-space-id même lors de l’utilisation d’une clé API d’équipe.
Exemple :
archbee get-doc --api-key abteam_xxx --doc-space-id SPACE_IDCommandes qui ne nécessitent pas --doc-space-id
Ces commandes au niveau de l’équipe peuvent être exécutées en utilisant uniquement une clé API d’équipe :
- exportation
- règles-d’affichage
- create-space
- téléverser
- liste-fichiers
- supprimer-fichier
- déplacer-fichier
- remplacer-le-fichier
Clés API en lecture seule
Les clés API d’équipe en lecture seule ne peuvent pas modifier le contenu.
Des commandes comme celles-ci échoueront avec des clés en lecture seule :
- create-doc
- supprimer-doc
- publish-space
- mise à jour de l’espace
Dépannage de l’authentification
Clé API invalide
Vérifiez :
- La clé n’a pas expiré
- La clé appartient à la bonne équipe ou au bon espace
- Il n’y a pas d’espaces ou de guillemets supplémentaires dans la commande
Erreurs d’accès à l’espace
Assurez-vous que la clé API a l’autorisation d’accéder à l’espace spécifié.
Autorisation de commande refusée
Utilisez une clé d’équipe avec autorisation d’écriture pour les commandes qui modifient les données.