Määritä Knowledge Base -API:n testaamiseen tai sovelluksen liittämiseen tarvittava todentaminen.
Knowledge Base -API-pyynnöt käyttävät bearer-tunnus-todentamista. Käytä todennettua käyttäjätunnusta lyhytaikaiseen testaukseen tai määritä tekninen tili sovellusta tai integrointia varten.
Ennen aloittamista
Varmista, että:
- organisaatiollasi on käyttöoikeus Knowledge Base -palveluun.
- Sinulla on käyttöoikeus työnkulkuusi tarvittaviin API-resursseihin.
- Voit käyttää Adobe Developer Consolea, jos olet määrittämässä sovellusintegrointia.
API-käyttöoikeus ei ohita Knowledge Base -käyttöoikeuksia. Todennetulla identiteetillä on oltava käyttöoikeus kokoelmiin, asiakirjoihin ja toimintoihin, joita sovellus pyytää.
Valitse todennusmenetelmä
Käytä kehitysvaiheesi mukaista todentamismenetelmää.
| Käyttötapaus | Todennus |
|---|---|
| Testipyynnöt tai API:n tutkiminen | Todennettu käyttäjän bearer-tunnus |
| Kehitä sovellus tai integraatio | Tekninen tili |
Käyttäjän bearer-tunnus
Todennettu käyttäjän bearer-tunnus on hyödyllinen API-pyyntöjen testaamiseen, mukaan lukien API-viitteen kautta tehdyt pyynnöt.
Tunnus edustaa sisäänkirjautunutta käyttäjää ja on voimassa 24 tuntia. Tunnuksella tehdyillä pyynnöillä on sama Knowledge Base -käyttöoikeus kuin kyseisellä käyttäjällä.
Hanki käyttäjän bearer-tunnus ja sisällytä se jokaiseen pyyntöön:
Authorization: Bearer <access-token>
Voit käyttää tunnusta myös vuorovaikutteisen Knowledge Base -API-viitteen kanssa käytettävissä olevien päätepisteiden testaamiseen.
Aloita toiminnolla, joka hakee resurssin, johon sinulla on jo käyttöoikeus. Onnistunut vastaus vahvistaa, että tunnus on hyväksytty ja todennettu identiteetti voi käyttää kyseistä resurssia.
Älä rakenna pysyvää sovellusintegrointia käyttäjän bearer-tunnuksen ympärille.
Tekninen tili
Käytä teknistä tiliä sovelluksiin ja integrointeihin, jotka täytyy todentaa ilman vuorovaikutteista käyttäjäistuntoa.
Tekniset tilit määritetään Adobe Developer Consolen kautta. Noudata teknisen tilin määritysprosessia luodaksesi sovelluksesi vaatiman todentamisen.
Kun olet luonut teknisen tilin, palaa tälle sivulle vahvistaaksesi pääsysi Knowledge Base API:in.
Tutustu API:en käyttöoikeuksiin
Todentaminen määrittää API-pyynnön tekevän henkilöllisyyden. Valtuutus määrittää, mitä kyseinen henkilöllisyys voi tehdä.
Esimerkiksi todennetulla henkilöllisyydellä voi olla oikeus hakea yksi kokoelma mutta ei toista, tai sillä ei välttämättä ole pääsyä järjestelmänvalvojatason resurssiin.
Jos todentaminen onnistuu mutta toiminto hylätään, tarkista, että todennetulla henkilöllisyydellä on oikeus käyttää pyydettyä resurssia ennen kuin käsittelet vastauksen todentamisvirheenä.
Vahvista API-käyttöoikeutesi
Kun todentaminen on määritetty:
- Luo käyttöoikeustunnus.
- Lähetä pyyntö resurssiin, johon tunnistetulla henkilöllisyydellä on pääsy.
- Varmista, että API palauttaa odotetun vastauksen.
- Jatka API:n aloitettua työnkulkua.
