Autentisera och få tillgång till Privacy Service API
Den här guiden ger en introduktion till de centrala koncept du måste känna till innan du försöker ringa anrop till Adobe Experience Platform Privacy Service API.
Förhandskrav prerequisites
Den här handboken kräver en fungerande förståelse av Privacy Service och hur den gör att du kan hantera förfrågningar från dina registrerade (kunder) i olika Adobe Experience Cloud-program.
För att kunna skapa åtkomstautentiseringsuppgifter för API:t måste en administratör i din organisation tidigare ha konfigurerat produktprofiler för Privacy Service i Adobe Admin Console. Den produktprofil som du tilldelar till en API-integrering avgör vilka behörigheter som integreringen har för åtkomst till Privacy Service-funktioner. Mer information finns i handboken om hantering av Privacy Service-behörigheter.
Samla in värden för obligatoriska rubriker gather-values-required-headers
För att kunna ringa anrop till Privacy Service API måste du först samla in dina inloggningsuppgifter och använda dem i obligatoriska rubriker:
Authorization: Bearer {ACCESS_TOKEN}x-api-key: {API_KEY}x-gw-ims-org-id: {ORG_ID}
Dessa värden genereras med Adobe Developer Console. {ORG_ID} och {API_KEY} behöver bara genereras en gång och kan återanvändas i framtida API-anrop. Din {ACCESS_TOKEN} är temporär och måste genereras om var 24:e timme.
Stegen för att generera dessa värden beskrivs närmare nedan.
Engångskonfiguration one-time-setup
Gå till Adobe Developer Console och logga in med din Adobe ID. Följ sedan stegen som beskrivs i självstudiekursen om att skapa ett tomt projekt i Developer Console-dokumentationen.
När du har skapat ett nytt projekt väljer du Add to Project och väljer API i listrutan.
Välj Privacy Service API select-privacy-service-api
Skärmen Add an API visas. Välj Experience Cloud om du vill begränsa listan över tillgängliga API:er och markera sedan kortet för Privacy Service API innan du väljer Next.
Välj sedan autentiseringstypen för att generera åtkomsttoken och få åtkomst till Privacy Service API.
Tilldela behörigheter via produktprofiler product-profiles
Det sista konfigurationssteget är att välja de produktprofiler som den här integreringen ska ärva sina behörigheter från. Om du väljer mer än en profil kombineras deras behörighetsgrupper för integreringen.
När du är klar väljer du Save configured API.
När API:t har lagts till i projektet visar Privacy Service API-sidan för projektet följande autentiseringsuppgifter som krävs i alla anrop till Privacy Service API
{API_KEY}(Client ID){ORG_ID}(Organization ID)
Autentisering för varje session authentication-each-session
Den sista obligatoriska autentiseringen som du måste samla in är din {ACCESS_TOKEN}, som används i auktoriseringshuvudet. Till skillnad från värdena för {API_KEY} och {ORG_ID} måste en ny token genereras var 24:e timme för att du ska kunna fortsätta använda API:t.
I allmänhet finns det två metoder för att generera en åtkomsttoken:
- Generera token manuellt för testning och utveckling.
- Automatisera tokengenerering för API-integreringar.
Generera en token manuellt manual-token
Om du vill generera en ny {ACCESS_TOKEN} manuellt går du till Credentials > OAuth Server-to-Server och väljer Generate access token enligt nedan.
En ny åtkomsttoken genereras och en knapp för att kopiera token till Urklipp tillhandahålls. Det här värdet används för det obligatoriska Authorization-huvudet och måste anges i formatet Bearer {ACCESS_TOKEN}.
Automatisera generering av token auto-token
Du kan också använda en Postman-miljö och en samling för att generera åtkomsttoken. Mer information finns i avsnittet om att använda Postman för att autentisera och testa API-anrop i autentiseringsguiden för Experience Platform API.
Läser exempel-API-anrop read-sample-api-calls
Varje slutpunktshandbok innehåller exempel på API-anrop som visar hur du formaterar dina begäranden. Det kan vara sökvägar, obligatoriska rubriker och korrekt formaterade begärandenyttolaster. Ett exempel på JSON som returneras i API-svar finns också. Information om konventioner som används i dokumentationen för exempel-API-anrop finns i avsnittet Så här läser du exempel-API-anrop i Komma igång-guiden för Experience Platform API:er.
Nästa steg next-steps
Nu när du förstår vilka rubriker du ska använda kan du börja ringa anrop till Privacy Service API. Välj någon av slutpunktsguiderna för att komma igång: