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 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 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 gids over het beheren van de toestemmingen van de Privacy Servicevoor 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 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 one-time-setup
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.
Selecteer de Privacy Service-API select-privacy-service-api
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.
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 als u klaar bent.
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)
Verificatie voor elke sessie authentication-each-session
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 manual-token
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).
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 auto-token
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 Experience Platform API authentificatiegids voor authentiek te verklaren en te testen.
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 overeenkomsten die in documentatie voor steekproef API vraag worden gebruikt, zie de sectie op hoe te voorbeeld API vraagin de begonnen gids voor Platform APIs lezen.
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: