De Privacy Service-API verifiëren en openen
Deze gids verstrekt een inleiding aan de kernconcepten u moet kennen alvorens te proberen om vraag aan Adobe Experience Platform Privacy Service API te maken.
Vereisten prerequisites
Deze handleiding vereist een goed begrip van Privacy Service en hoe u hiermee toegang kunt beheren en aanvragen van uw betrokkenen (klanten) kunt verwijderen voor alle Adobe Experience Cloud-toepassingen.
Als u toegangsreferenties voor de API wilt maken, moet een beheerder binnen uw organisatie eerder productprofielen hebben ingesteld voor Privacy Service binnen Adobe Admin Console. Het productprofiel dat u toewijst aan een API-integratie, bepaalt welke machtigingen integratie heeft wanneer u toegang krijgt tot Privacy Service-mogelijkheden. Zie de handleiding op beheren, machtigingen voor Privacy Service voor meer informatie .
Waarden verzamelen voor vereiste koppen gather-values-required-headers
Om vraag aan Privacy Service API te maken, moet u uw toegangsgeloofsbrieven eerst verzamelen die in vereiste kopballen moeten worden gebruikt:
Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {ORG_ID}
Deze waarden worden gegenereerd met Adobe Developer Console. Uw {ORG_ID}
en {API_KEY}
moet slechts eenmaal worden gegenereerd en kan in toekomstige API-aanroepen opnieuw worden gebruikt. Uw {ACCESS_TOKEN}
is tijdelijk en moet om de 24 uur opnieuw worden gegenereerd.
De stappen voor het genereren van deze waarden worden hieronder in detail besproken.
Eenmalige installatie one-time-setup
Ga naar Adobe Developer Console en meld u aan met uw Adobe ID. Voer vervolgens de stappen uit die in de zelfstudie worden beschreven een leeg project maken in de documentatie van de Developer Console.
Als u een nieuw project hebt gemaakt, selecteert u Add to Project en kiest u API in het vervolgkeuzemenu.
Selecteer de Privacy Service-API select-privacy-service-api
De Add an API wordt weergegeven. Selecteren Experience Cloud om de lijst met beschikbare API's te beperken, selecteert u vervolgens de kaart voor Privacy Service API voordat u selecteert Next.
Selecteer vervolgens het verificatietype dat u wilt maken voor het genereren van toegangstokens en voor toegang tot de Privacy Service-API.
Machtigingen toewijzen via productprofielen product-profiles
De laatste configuratiestap bestaat uit het selecteren van de productprofielen waarvan deze integratie de machtigingen erft. Als u meer dan één profiel selecteert, worden de rechtensets gecombineerd voor de integratie.
Selecteer Save configured API.
Zodra API aan het project is toegevoegd, Privacy Service API De pagina voor het project toont de volgende geloofsbrieven die in alle vraag aan Privacy Service APIs worden vereist:
{API_KEY}
(Client ID){ORG_ID}
(Organization ID)
Verificatie voor elke sessie authentication-each-session
De laatste vereiste referentie die u moet verzamelen is uw {ACCESS_TOKEN}
, die wordt gebruikt in de kop Autorisatie. In tegenstelling tot de waarden voor {API_KEY}
en {ORG_ID}
moet om de 24 uur een nieuw token worden gegenereerd om de API te kunnen blijven gebruiken.
Over het algemeen zijn er twee methoden om een toegangstoken te genereren:
- De token handmatig genereren voor tests en ontwikkeling.
- Automatisch token genereren voor API-integratie.
Een token handmatig genereren manual-token
Om een nieuwe manueel te produceren {ACCESS_TOKEN}
, navigeer naar Credentials > OAuth Server-to-Server en selecteert u Generate access token, zoals hieronder weergegeven.
Er wordt een nieuw toegangstoken gegenereerd en er wordt een knop opgegeven waarmee het token naar het klembord kan worden gekopieerd. Deze waarde wordt gebruikt voor de vereiste Authorization en moet worden opgegeven in de vorm Bearer {ACCESS_TOKEN}
.
Automatisch token genereren auto-token
U kunt ook een Postman-omgeving en -verzameling gebruiken om toegangstokens te genereren. Lees voor meer informatie de sectie over het gebruiken van Postman om API vraag voor authentiek te verklaren en te testen in de Experience Platform API-verificatiegids.
API-voorbeeldaanroepen lezen read-sample-api-calls
Elke eindpuntgids verstrekt voorbeeld API vraag om aan te tonen hoe te om uw verzoeken te formatteren. Dit zijn paden, vereiste kopteksten en correct opgemaakte ladingen voor aanvragen. Voorbeeld-JSON die wordt geretourneerd in API-reacties, wordt ook verschaft. Voor informatie over de conventies die worden gebruikt in documentatie voor voorbeeld-API-aanroepen raadpleegt u de sectie over voorbeeld-API-aanroepen lezen in de gids Aan de slag voor Platform APIs.
Volgende stappen next-steps
Nu u begrijpt welke kopballen aan gebruik, bent u bereid beginnen het maken vraag aan Privacy Service API. Selecteer een van de eindpunthulplijnen om aan de slag te gaan: