Konfigurer autentiseringen som kreves for å teste Knowledge Base API-et eller koble en applikasjon til det.
Knowledge Base API-forespørsler bruker bearer-token-autentisering. Bruk et autentisert brukertoken for kortsiktig testing, eller konfigurer en teknisk konto for en applikasjon eller integrasjon.
Før du begynner
Sørg for at:
- Organisasjonen din har tilgang til Knowledge Base.
- Du har tilgang til API-ressursene som kreves for arbeidsflyten din.
- Du kan få tilgang til Adobe Developer Console hvis du setter opp en applikasjonsintegrasjon.
API-tilgang overstyrer ikke Knowledge Base-tillatelser. Den autentiserte identiteten må ha tilgang til samlingene, dokumentene og operasjonene som forespørres av applikasjonen.
Velg en autentiseringsmetode
Bruk autentiseringsmetoden som passer til utviklingsstadiet ditt.
| Bruksområde | Godkjenning |
|---|---|
| Test forespørsler eller utforsk API-et | Autentisert bruker bearer-token |
| Bygg en applikasjon eller integrasjon | Teknisk konto |
Bruker bearer-token
Et autentisert bruker-bearer-token er nyttig for å teste API-forespørsler, inkludert forespørsler som gjøres gjennom API-referansen.
Tokenet representerer den påloggede brukeren og er gyldig i 24 timer. Forespørsler som gjøres med tokenet har samme Knowledge Base-tilgang som er tilgjengelig for den brukeren.
Etter å ha fått et bruker bearer-token, inkluder det med hver forespørsel:
Authorization: Bearer <access-token>
Du kan også bruke tokenet med den interaktive Knowledge Base API-referansen for å teste tilgjengelige endepunkter.
Start med en operasjon som henter en ressurs du allerede har tilgang til. Et vellykket svar bekrefter at tokenet er akseptert og at den autentiserte identiteten kan få tilgang til den ressursen.
Ikke bygg en vedvarende applikasjonsintegrasjon rundt et bruker bearer-token.
Teknisk konto
Bruk en teknisk konto for applikasjoner og integrasjoner som må autentisere uten en interaktiv brukerøkt.
Tekniske kontoer konfigureres gjennom Adobe Developer Console. Følg oppsettprosessen for teknisk konto for å opprette legitimasjonen som applikasjonen din trenger.
Etter at du har opprettet den tekniske kontoen, går du tilbake til denne siden for å validere tilgangen din til Knowledge Base-API-et.
Forstå API-tillatelser
Autentisering fastslår identiteten som sender API-forespørselen. Autorisering bestemmer hva den identiteten kan gjøre.
For eksempel kan en autentisert identitet hente én samling, men ikke en annen, eller ikke ha tilgang til en ressurs på administratornivå.
Hvis autentisering lykkes, men en operasjon avvises, kontroller at den autentiserte identiteten har tillatelse til å få tilgang til den forespurte ressursen før du behandler svaret som en autentiseringsfeil.
Valider API-tilgangen din
Etter at autentiseringen er konfigurert:
- Skaff et tilgangstoken.
- Send en forespørsel til en ressurs som den autentiserte identiteten har tilgang til.
- Bekreft at API-et returnerer det forventede svaret.
- Fortsett med arbeidsflyten for å komme i gang med API-et.
