Skip to main content
U hebt OAuth niet nodig om de Public API te gebruiken. Begin voor een privé-integratie aan de serverzijde met een API-sleutel met beperkt bereik en volg de quickstart. Kies OAuth client credentials wanneer uw beveiligingsbeleid kortlevende toegangstokens vereist of uw integratieplatform die flow al ondersteunt. Beide opties gebruiken een serviceaccount. Een serviceaccount is de identiteit van de integratie en geen derde authenticatiemethode.

​
Hoe de onderdelen samenhangen

Maak per integratie één serviceaccount aan. Kies voor dat account een API-sleutel of een OAuth-client; u hebt niet beide methoden nodig bij elk API-verzoek. Geen van beide referenties kan de huidige machtigingen van het account overschrijden. De quickstart gebruikt Basic-authenticatie. Een Bearer-header wordt ook ondersteund voor API-sleutels; het gebruik van die header betekent niet dat u een OAuth-client nodig hebt.

​
Kies een API-sleutel voor een eenvoudige integratie

Gebruik een API-sleutel voor uw eigen geplande taken, rapportagescripts, datapijplijnen of andere backendservices wanneer een geheim dat in uw secretmanager is opgeslagen voldoet aan uw beveiligingseisen.
  • Doe rechtstreeks geauthenticeerde verzoeken; een tokenuitwisseling is niet nodig.
  • Selecteer alleen de machtigingen die de workload nodig heeft en stel een vervaldatum in.
  • Roteer de sleutel met behulp van de overlapperiode, of trek de sleutel direct in als deze is blootgesteld.
Een integratie met een API-sleutel heeft geen OAuth-client nodig. Begin met de quickstart en zie vervolgens API-sleutels voor het aanmaken en roteren.

​
Kies OAuth voor kortlevende toegangstokens

Gebruik OAuth client credentials voor een vertrouwelijke backendservice wanneer uw organisatie verlopende toegangstokens vereist of een integratietool de client_credentials-grant verwacht.
  1. Maak een OAuth-client met beperkt bereik aan voor het serviceaccount.
  2. Authenticeer de client bij uw regionale tokenendpoint met de clientauthenticatiemethode die tijdens de configuratie is opgegeven.
  3. Stuur het verkregen toegangstoken mee met uw API-verzoeken. Vraag een nieuw token aan voordat het huidige token verloopt.
OAuth voegt het verkrijgen van tokens en het afhandelen van verloop toe aan uw integratie. Het clientgeheim moet nog steeds veilig worden opgeslagen en geroteerd; kortlevende tokens nemen die verantwoordelijkheid niet weg. Client credentials gebruikt geen refresh-tokens: authenticeer de client opnieuw om een nieuw toegangstoken te verkrijgen. OAuth-toegang moet voor uw organisatie zijn ingeschakeld. Als deze niet is ingeschakeld, gebruikt u een API-sleutel of neemt u contact op met Living Security Support over uw vereisten. Zie OAuth client credentials voor het aanmaken van clients, eenmalige geheimen, intrekking en herstel.

​
Houd referenties op uw backend

API-sleutels van serviceaccounts en OAuth-clientgeheimen horen thuis in opslag voor geheimen aan de serverzijde. Plaats ze niet in browsercode, mobiele apps, broncodebeheer of logs. Een referentie van een serviceaccount handelt namens de workload; het meldt geen persoon aan en biedt geen flow voor klanttoestemming. Gebruik voor beide methoden de regionale API-host van uw organisatie. Het wijzigen van de authenticatiemethode verandert niets aan de resource-URL, de API-versie of de machtigingen die een bewerking vereist.