Configureer de authenticatie die nodig is om de Knowledge Base-API te testen of er een applicatie op aan te sluiten.
Knowledge Base-API-verzoeken gebruiken bearer-token-authenticatie.Gebruik een geauthenticeerd gebruikers-token voor korte-termijn testen, of configureer een technisch account voor een applicatie of integratie.
Voordat u begint
Zorg ervoor dat:
- Je organisatie heeft toegang tot Knowledge Base.
- Je toegang hebt tot de API-resources die nodig zijn voor je workflow.
- Je toegang hebt tot Adobe Developer Console als je een applicatie-integratie instelt.
API-toegang heft knowledgebase-toestemmingen niet tijdelijk op.De geauthenticeerde identiteit moet toegang hebben tot de verzamelingen, documenten en bewerkingen die door de applicatie worden aangevraagd.
Kies een authenticatiemethode
Gebruik de authenticatiemethode die past bij je ontwikkelingsstadium.
| Gebruiksscenario | Verificatie |
|---|---|
| Verzoeken testen of de API verkennen | Bearer-token van geauthenticeerde gebruiker |
| Een applicatie of integratie bouwen | Technisch account |
Bearer-token van de gebruiker
Een geauthenticeerd gebruikers bearer-token is handig voor het testen van API-verzoeken, inclusief verzoeken die via de API-referentie worden gedaan.
Het token vertegenwoordigt de ingelogde gebruiker en is vierentwintig uur geldig.Verzoeken die met het token worden gedaan, hebben dezelfde knowledgebase-toegang die beschikbaar is voor die gebruiker.
Na het verkrijgen van een bearer-token van een gebruiker, voeg je het toe aan elk verzoek:
Authorization: Bearer <access-token>
Je kunt het token ook gebruiken met de interactieve Kennisbank-API-referentie om beschikbare eindpunten te testen.
Begin met een bewerking die een resource ophaalt waartoe je al toegang hebt.Een succesvol antwoord bevestigt dat het token wordt geaccepteerd en de geauthenticeerde identiteit toegang heeft tot die resource.
Bouw geen persistente applicatie-integratie rond een gebruikers bearer-token.
Technisch account
Gebruik een technisch account voor applicaties en integraties die moeten worden geverifieerd zonder een interactieve gebruikerssessie.
Technische accounts worden geconfigureerd via Adobe Developer Console. Volg het installatieproces voor technische accounts om de aanmeldingsgegevens te maken die je applicatie nodig heeft.
Nadat je het technische account hebt gemaakt, keer je terug naar deze pagina om je toegang tot de Knowledge Base-API te valideren.
API-toestemmingen begrijpen
Authenticatie bepaalt welke identiteit het API-verzoek indient.Toestemming bepaalt wat die identiteit kan doen.
Een geverifieerde identiteit heeft bijvoorbeeld mogelijk toegang tot de ene collectie, maar niet tot de andere, of heeft geen toegang tot een resource op beheerderniveau.
Als authenticatie slaagt maar een bewerking wordt afgewezen, controleer dan of de geverifieerde identiteit toestemming heeft om toegang te krijgen tot de aangevraagde resource voordat je de reactie behandelt als een authenticatiefout.
Je API-toegang valideren
Nadat authenticatie is geconfigureerd:
- Een toegangstoken verkrijgen.
- Een verzoek indienen bij een resource waartoe de geverifieerde identiteit toegang heeft.
- Bevestigen dat de API de verwachte reactie retourneert.
- Doorgaan met de workflow Getting started van de API.
