Documentatie Experience Platform Handleiding voor Privacy Service

De Privacy Service API verifiëren en openen

Last update: Mon May 05 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

Onderwerpen:

Gemaakt voor:

Ontwikkelaar

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

Deze gids vereist een werkend begrip van Privacy Serviceen hoe het u toestaat om toegang te beheren en verzoeken van uw gegevensproefpersonen (klanten) over de toepassingen van Adobe Experience Cloud te schrappen.

Als u toegangsreferenties voor de API wilt maken, moet een beheerder binnen uw organisatie eerder productprofielen voor Privacy Service in Adobe Admin Console hebben ingesteld. Het productprofiel dat u toewijst aan een API-integratie, bepaalt welke machtigingen integratie heeft voor toegang tot Privacy Service-mogelijkheden. Zie de gids over het beheren van de toestemmingen van Privacy Servicevoor meer informatie.

Waarden verzamelen voor vereiste koppen

Als u aanroepen wilt uitvoeren naar de Privacy Service API, moet u eerst de toegangsreferenties verzamelen die in de vereiste headers moeten worden gebruikt:

Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {ORG_ID}

Deze waarden worden geproduceerd gebruikend Adobe Developer Console. Uw {ORG_ID} en {API_KEY} hoeven slechts eenmaal te worden gegenereerd en kunnen in toekomstige API-aanroepen opnieuw worden gebruikt. Uw {ACCESS_TOKEN} is echter tijdelijk en moet elke 24 uur opnieuw worden gegenereerd.

De stappen voor het genereren van deze waarden worden hieronder in detail besproken.

Eenmalige installatie

Ga naar Adobe Developer Consoleen teken binnen met uw Adobe ID. Daarna, volg de stappen die in het leerprogramma worden geschetst op creërend een leeg projectin de documentatie van Developer Console.

Als u een nieuw project hebt gemaakt, selecteert u Add to Project en kiest u API in het vervolgkeuzemenu.

de API optie die van Add to Project dropdown van de pagina van projectdetails in Developer Console wordt geselecteerd

De Privacy Service API selecteren

Het scherm Add an API wordt weergegeven. Selecteer Experience Cloud om de lijst met beschikbare API's te beperken en selecteer vervolgens de kaart voor Privacy Service API voordat u Next selecteert.

De Privacy Service API kaart die van de lijst van beschikbare APIs wordt geselecteerd

TIP

Selecteer de View docs optie om in een afzonderlijk browser venster aan de volledige Privacy Service API verwijzingsdocumentatiete navigeren.

Selecteer vervolgens het verificatietype dat u wilt genereren voor toegangstokens en toegang tot de Privacy Service API.

IMPORTANT

Selecteer de methode OAuth Server-to-Server omdat dit de enige methode is die u kunt gebruiken om door te gaan. De methode Service Account (JWT) is vervangen. Terwijl de integratie die de authentificatiemethode JWT gebruikt tot 1 Januari, 2025 zal blijven werken, adviseert Adobe sterk dat u bestaande integratie aan de nieuwe server-aan-server methode OAuth vóór die datum migreert. Krijg meer informatie in de sectie Afgekeurd produceer een Token van het Web JSON (JWT).

Uitgezochte Oauth server-aan-Server authentificatiemethode.

Machtigingen toewijzen via productprofielen

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.

NOTE

Productprofielen en de bijbehorende granulaire machtigingen worden door beheerders gemaakt en beheerd via Adobe Admin Console. Zie de gids op toestemmingen van Privacy Servicevoor meer informatie.

Selecteer Save configured API als u klaar bent.

één enkel productprofiel dat van de lijst wordt geselecteerd alvorens de configuratie op te slaan

Zodra API aan het project is toegevoegd, Privacy Service API toont de pagina voor het project de volgende geloofsbrieven die in alle vraag aan Privacy Service APIs worden vereist:

{API_KEY} (Client ID)
{ORG_ID} (Organization ID)

de informatie van de Integratie na het toevoegen van API in Developer Console.

Verificatie voor elke sessie

De laatste vereiste referentie die u moet verzamelen, is de {ACCESS_TOKEN} , die wordt gebruikt in de machtigingheader. 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:

produceer manueel het tekenvoor het testen en ontwikkeling.
Automatiseer symbolische generatievoor API integratie.

Een token handmatig genereren

Als u handmatig een nieuwe {ACCESS_TOKEN} wilt genereren, navigeert u naar Credentials > OAuth Server-to-Server en selecteert u Generate access token (zie hieronder).

het schermopname van A van hoe een toegangstoken in Developer Console UI wordt geproduceerd.

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 header en moet worden opgegeven in de indeling Bearer {ACCESS_TOKEN} .

Automatisch token genereren

U kunt ook een Postman-omgeving en -verzameling gebruiken om toegangstokens te genereren. Voor meer informatie, lees de sectie over gebruikend Postman om API vraagin de de authentificatiegids van Experience Platform voor authentiek te verklaren en te testen API.

API-voorbeeldaanroepen lezen

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 overeenkomsten die in documentatie voor steekproef API vraag worden gebruikt, zie de sectie op hoe te om voorbeeld API vraagin de begonnen gids voor Experience Platform APIs te lezen.

Volgende stappen

Nu u begrijpt welke headers u moet gebruiken, bent u klaar om te beginnen met het oproepen van de Privacy Service API. Selecteer een van de eindpunthulplijnen om aan de slag te gaan:

recommendation-more-help