Konfigurera den autentisering som krävs för att testa Knowledge Base-API:et eller ansluta en applikation till det.
Knowledge Base-API-förfrågningar använder bearer-token-autentisering. Använd en autentiserad användartoken för kortvariga tester eller konfigurera ett tekniskt konto för en applikation eller integration.
Innan du börjar
Se till att:
- Din organisation har åtkomst till Knowledge Base.
- Du har åtkomst till API-resurserna som krävs för ditt arbetsflöde.
- Du kan komma åt Adobe Developer Console om du konfigurerar en applikationsintegration.
API-åtkomst åsidosätter inte Knowledge Base-behörigheter. Den autentiserade identiteten måste ha åtkomst till samlingarna, dokumenten och operationerna som begärs av applikationen.
Välj en autentiseringsmetod
Använd den autentiseringsmetod som passar ditt utvecklingsstadium.
| användningsfall | Autentisering |
|---|---|
| Testa förfrågningar eller utforska API:et | Autentiserad användar-bearer-token |
| Bygg en applikation eller integration | Tekniskt konto |
Användar-bearer-token
En autentiserad användar-bearer-token är användbar för att testa API-förfrågningar, inklusive förfrågningar som görs via API-referensen.
Tokenen representerar den inloggade användaren och är giltig i 24 timmar. Förfrågningar som görs med tokenen har samma Knowledge Base-åtkomst som är tillgänglig för den användaren.
När du har fått en användar-bearer-token, inkludera den med varje förfrågan:
Authorization: Bearer <access-token>
Du kan också använda tokenen med den interaktiva Knowledge Base-API-referensen för att testa tillgängliga slutpunkter.
Börja med en operation som hämtar en resurs du redan har åtkomst till. Ett lyckat svar bekräftar att tokenen accepteras och att den autentiserade identiteten kan komma åt den resursen.
Bygg inte en beständig applikationsintegration runt en användar-bearer-token.
Tekniskt konto
Använd ett tekniskt konto för applikationer och integrationer som behöver autentisering utan en interaktiv användarsession.
Tekniska konton konfigureras via Adobe Developer Console. Följ installationsprocessen för tekniskt konto för att skapa de autentiseringsuppgifter som din applikation behöver.
När du har skapat det tekniska kontot återgår du till den här sidan för att bekräfta din åtkomst till Knowledge Base API.
Förstå API-behörigheter
Autentisering fastställer identiteten som gör API-begäran.Auktorisering avgör vad den identiteten kan göra.
Till exempel kan en autentiserad identitet hämta en samling men inte en annan, eller kanske inte ha åtkomst till en resurs på administratörsnivå.
Om autentisering lyckas men en operation avvisas, kontrollera att den autentiserade identiteten har behörighet att komma åt den begärda resursen innan du behandlar svaret som ett autentiseringsfel.
Validera din API-åtkomst
När autentisering har konfigurerats:
- Skaffa en åtkomsttoken.
- Skicka en begäran till en resurs som den autentiserade identiteten kan komma åt.
- Bekräfta att API:et returnerar det förväntade svaret.
- Fortsätt med arbetsflödet för att komma igång med API.
