Configurez l’authentification requise pour tester l’API Knowledge Base ou y connecter une application.
Les demandes de l’API Knowledge Base utilisent l’authentification par jeton porteur. Utilisez un jeton d’utilisateur authentifié pour les tests à court terme, ou configurez un compte technique pour une application ou une intégration.
Avant de commencer
Assurez-vous que :
- Votre organisation a accès à Knowledge Base.
- Vous avez accès aux ressources d’API requises pour votre workflow.
- Vous pouvez accéder à Adobe Developer Console si vous configurez une intégration d’application.
L’accès API ne remplace pas les autorisations de Knowledge Base. L’identité authentifiée doit avoir accès aux collections, documents et opérations demandés par l’application.
Choisissez une méthode d’authentification
Utilisez la méthode d’authentification qui correspond à votre étape de développement.
| Cas d’utilisation | Authentification |
|---|---|
| Tester les requêtes ou explorer l’API | Jeton porteur d’utilisateur authentifié |
| Créer une application ou une intégration | Compte technique |
Jeton porteur d’utilisateur
Un jeton porteur d’utilisateur authentifié est utile pour tester les demandes d’API, y compris les demandes effectuées via la référence d’API.
Le jeton représente l’utilisateur connecté et est valide pendant 24 heures. Les demandes effectuées avec le jeton ont le même accès à Knowledge Base disponible pour cet utilisateur.
Après avoir obtenu un jeton porteur d’utilisateur, incluez-le avec chaque demande :
Authorization: Bearer <access-token>
Vous pouvez également utiliser le jeton avec la référence d’API Knowledge Base interactive pour tester les points d’entrée disponibles.
Commencez par une opération qui récupère une ressource à laquelle vous avez déjà accès. Une réponse réussie confirme que le jeton est accepté et que l’identité authentifiée peut accéder à cette ressource.
Ne créez pas d’intégration d’application persistante autour d’un jeton porteur d’utilisateur.
Compte technique
Utilisez un compte technique pour les applications et intégrations qui doivent s’authentifier sans session utilisateur interactive.
Les comptes techniques sont configurés via Adobe Developer Console. Suivez le processus de configuration de compte technique pour créer les informations d’identification requises par votre application.
Après avoir créé le compte technique, revenez à cette page pour valider votre accès à l’API Knowledge Base.
Autorisations d’API
L’authentification établit l’identité qui effectue la demande d’API. L’autorisation détermine ce que cette identité peut faire.
Par exemple, une identité authentifiée peut être en mesure de récupérer une collection, mais pas une autre, ou peut ne pas avoir accès à une ressource de niveau administrateur.
Si l’authentification réussit mais qu’une opération est rejetée, vérifiez que l’identité authentifiée dispose de l’autorisation d’accéder à la ressource demandée avant de traiter la réponse comme un échec d’authentification.
Validez votre accès à l’API
Une fois l’authentification configurée :
- Obtenez un jeton d’accès.
- Envoyez une demande à une ressource à laquelle l’identité authentifiée peut accéder.
- Confirmez que l’API renvoie la réponse attendue.
- Continuez avec le workflow de prise en main de l’API.
