Konfiguriere die Authentifizierung, die erforderlich ist, um die Knowledgebase-API zu testen oder eine Anwendung damit zu verbinden.
Anfragen an die Knowledgebase-API verwenden eine Bearer-Token-Authentifizierung. Verwende ein authentifiziertes Benutzer-Token für kurzfristige Tests oder konfiguriere ein technisches Konto für eine Anwendung oder Integration.
Vorbereitungsmaßnahmen
Stelle sicher, dass:
- deine Organisation Zugriff auf die Knowledgebase hat.
- du Zugriff auf die API-Ressourcen, die für deinen Workflow erforderlich sind, hast.
- du auf die Adobe Developer Console zugreifen kannst, wenn du eine Anwendungsintegration einrichtest.
API-Zugriff überschreibt nicht die Knowledgebase-Berechtigungen. Die authentifizierte Identität muss Zugriff auf die Sammlungen, Dokumente und Vorgänge haben, die von der Anwendung angefordert werden.
Authentifizierungsmethode wählen
Verwende die Authentifizierungsmethode, die zu deiner Entwicklungsphase passt.
| Anwendungsfall | Authentifizierung |
|---|---|
| Anfragen testen oder API erkunden | Authentifiziertes Benutzer-Bearer-Token |
| Anwendung oder Integration entwickeln | Technikkonto |
Benutzer-Bearer-Token
Ein authentifiziertes Benutzer-Bearer-Token ist nützlich zum Testen von API-Anfragen, einschließlich Anfragen über die API-Referenz.
Das Token repräsentiert den angemeldeten Benutzer und ist 24 Stunden gültig. Anfragen mit dem Token haben denselben Zugriff auf die Knowledgebase wie der Benutzer.
Nachdem du ein Benutzer-Bearer-Token erhalten hast, füge es jeder Anfrage hinzu:
Authorisierung: Bearer <access-token>
Du kannst das Token auch für die interaktive API-Referenz der Knowledgebase verwenden, um verfügbare Endpunkte zu testen.
Beginne mit einer Operation, die eine Ressource abruft, auf die du bereits Zugriff hast. Eine erfolgreiche Antwort bestätigt, dass das Token akzeptiert wird und die authentifizierte Identität auf diese Ressource zugreifen kann.
Entwickle keine dauerhafte Anwendungsintegration mit einem User-Bearer-Token.
Technikkonto
Verwende ein technisches Konto für Anwendungen und Integrationen, die sich ohne interaktive Benutzersitzung authentifizieren müssen.
Technische Konten werden in der Adobe Developer Console konfiguriert. Folge dem Einrichtungsprozess für technische Konten, um die Anmeldedaten zu erstellen, die deine Anwendung benötigt.
Nachdem du das technische Konto erstellt hast, kehre zu dieser Seite zurück, um deinen Zugriff auf die Knowledgebase-API zu validieren.
API-Berechtigungen verstehen
Die Authentifizierung legt die Identität fest, die die API-Anfrage sendet.Autorisierung bestimmt, was diese Identität tun darf.
Beispielsweise kann eine authentifizierte Identität möglicherweise eine Sammlung abrufen, aber nicht eine andere, oder sie hat keinen Zugriff auf eine Ressource auf Administratorebene.
Wenn die Authentifizierung erfolgreich ist, aber ein Vorgang abgelehnt wird, überprüfe, ob die authentifizierte Identität die Berechtigung hat, auf die angeforderte Ressource zuzugreifen, bevor du die Antwort als Authentifizierungsfehler behandelst.
API-Zugriff überprüfen
Nach der Konfiguration der Authentifizierung:
- Zugriffstoken erhalten
- Sende eine Anfrage an eine Ressource, auf die die authentifizierte Identität zugreifen kann.
- Bestätige, dass die API die erwartete Antwort zurückgibt.
- Fahre mit dem API-Erste-Schritte-Workflow fort.
