Autentisera och få åtkomst till Experience Platform-API:er

Det här dokumentet innehåller en stegvis självstudiekurs för att få tillgång till ett Adobe Experience Platform-utvecklarkonto för att ringa anrop till Experience Platform API:er. I slutet av den här självstudiekursen kommer du att ha genererat eller samlat in följande autentiseringsuppgifter som krävs som huvuden i alla API-anrop för plattformen:

  • {ACCESS_TOKEN}
  • {API_KEY}
  • {ORG_ID}
TIP
Förutom de tre autentiseringsuppgifterna ovan kräver många plattforms-API:er även en giltig {SANDBOX_NAME} som rubrik. Mer information om sandlådor som är tillgängliga för din organisation finns i översikten över sandlådor och i dokumentationen för slutpunkten för sandlådehantering.

För att skydda program och användare måste alla förfrågningar till Experience Platform API:er autentiseras och auktoriseras med standarder som OAuth.

I den här självstudiekursen beskrivs hur du samlar in nödvändiga inloggningsuppgifter för att autentisera API-anrop för plattformar, enligt vad som beskrivs i nedanstående flödesschema. Du kan samla de flesta nödvändiga autentiseringsuppgifter i den första engångsinställningen. Åtkomsttoken måste dock uppdateras var 24:e timme.

Förhandskrav prerequisites

För att kunna anropa Experience Platform API:er måste du ha följande:

  • En organisation med tillgång till Adobe Experience Platform.
  • En Admin Console-administratör som kan lägga till dig som utvecklare och som användare för en produktprofil.
  • En Experience Platform-systemadministratör som kan ge dig nödvändiga attributbaserade åtkomstkontroller för att kunna utföra läs- och skrivåtgärder på olika delar av Experience Platform via API:er.

Du måste också ha en Adobe ID för att slutföra kursen. Om du inte har någon Adobe ID kan du skapa en med följande steg:

  1. Gå till Adobe Developer Console.
  2. Välj Create a new account.
  3. Slutför registreringsprocessen.

Få utvecklare och användare åtkomst till Experience Platform gain-developer-user-access

Innan du skapar integreringar på Adobe Developer Console måste ditt konto ha utvecklar- och användarbehörigheter för en produktprofil för Experience Platform i Adobe Admin Console.

Få utvecklaråtkomst gain-developer-access

Kontakta en Admin Console-administratör i din organisation om du vill lägga till dig som utvecklare till en Experience Platform-produktprofil med hjälp av Admin Console. I Admin Console-dokumentationen finns specifika instruktioner om hur du hanterar utvecklaråtkomst för produktprofiler.

När du har tilldelats en utvecklare kan du börja skapa integreringar i Adobe Developer Console. Dessa integreringar är en pipeline från externa program och tjänster till Adobe-API:er.

Få användaråtkomst gain-user-access

Din Admin Console-administratör måste också lägga till dig som användare i samma produktprofil. Med användaråtkomst kan du i gränssnittet se resultatet av de API-åtgärder du utför.

Mer information finns i handboken om hantering av användargrupper i Admin Console.

Generera en API-nyckel (klient-ID) och ett företags-ID generate-credentials

NOTE
Om du följer det här dokumentet från Privacy Service-API-guiden kan du nu gå tillbaka till den guiden och generera autentiseringsuppgifter som är unika för Privacy Service.

När du har fått utvecklare och användare åtkomst till Platform via Admin Console är nästa steg att generera dina {ORG_ID} - och {API_KEY} -autentiseringsuppgifter i Adobe Developer Console. Dessa autentiseringsuppgifter behöver bara genereras en gång och kan återanvändas i framtida API-anrop för plattformen.

Lägga till Experience Platform i ett projekt add-platform-to-project

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 Adobe Developer Console-dokumentationen.

När du har skapat ett nytt projekt väljer du Add API på skärmen Project Overview.

TIP
Om du har etablerat dig för flera organisationer använder du organisationsväljaren i det övre högra hörnet av gränssnittet för att kontrollera att du är i den organisation du behöver.

Developer Console-skärmen med alternativet Lägg till API markerat.

Skärmen Add an API visas. Markera produktikonen för Adobe Experience Platform och välj sedan Experience Platform API innan du väljer Next.

Välj Experience Platform-API.

TIP
Välj alternativet View docs om du vill navigera i ett separat webbläsarfönster till den fullständiga Experience Platform API-referensdokumentationen.

Välj autentiseringstypen OAuth Server-to-Server select-oauth-server-to-server

Välj sedan autentiseringstypen OAuth Server-to-Server för att generera åtkomsttokens och få åtkomst till Experience Platform-API:t.

IMPORTANT
Metoden OAuth Server-to-Server är den enda tokengenereringsmetod som stöds för att gå framåt. Metoden Service Account (JWT) som tidigare stöddes är föråldrad och kan inte väljas för nya integreringar. Befintliga integreringar som använder JWT-autentiseringsmetoden fortsätter att fungera fram till 1 januari 2025, men Adobe rekommenderar starkt att du migrerar befintliga integreringar till den nya OAuth Server-to-Server-metoden före det datumet. Hämta mer information i avsnittet [Föråldrat]{class="badge negative"}Skapa en JSON-webbtoken (JWT).

Välj autentiseringsmetoden OAuth Server-till-Server för Experience Platform API:t.

Välj produktprofiler för integreringen select-product-profiles

Välj AEP-Default-All-Users på skärmen Configure API.

IMPORTANT
För att få tillgång till vissa funktioner i Platform behöver du också en systemadministratör som ger dig de nödvändiga attributbaserade behörigheterna för åtkomstkontroll. Läs mer i avsnittet Få de nödvändiga attributbaserade behörigheterna för åtkomstkontroll.

Välj produktprofiler för din integrering.

Välj Save configured API när du är klar.

En genomgång av de steg som beskrivs ovan för att konfigurera en integrering med API:t för Experience Platform finns också i videosjälvstudien nedan:

Samla in inloggningsuppgifter gather-credentials

När API:t har lagts till i projektet visar Experience Platform API-sidan för projektet följande autentiseringsuppgifter som krävs i alla anrop till API:er för Experience Platform:

Integreringsinformation efter att ett API har lagts till i Developer Console.

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

Generera en åtkomsttoken generate-access-token

Nästa steg är att generera en {ACCESS_TOKEN}-autentiseringsuppgift som kan användas i API-anrop för plattformar. 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 plattforms-API:er. Välj Generate access token enligt nedan.

Visa hur du genererar åtkomsttoken

TIP
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.

[Inaktuell]{class="badge negative"} Generera en JSON-webbtoken (JWT) jwt

WARNING
JWT-metoden för att generera åtkomsttoken har tagits bort. Alla nya integreringar måste skapas med autentiseringsmetoden OAuth Server-till-server. Adobe kräver också att du migrerar dina befintliga integreringar till OAuth-metoden senast 1 januari 2025 för att dina integreringar ska fortsätta fungera. Läs följande viktiga dokumentation:
Visa inaktuell information

Nästa steg är att generera en JSON Web Token (JWT) baserat på dina kontouppgifter. Det här värdet används för att generera dina {ACCESS_TOKEN}-autentiseringsuppgifter för användning i Platform API-anrop, som måste genereras om var 24:e timme.

note important
IMPORTANT
I den här självstudiekursen beskrivs hur du genererar en JWT-fil i Developer Console i stegen nedan. Denna genereringsmetod bör dock endast användas för testning och utvärdering.
För normal användning måste JWT genereras automatiskt. Mer information om programmässig generering av JWT finns i autentiseringsguiden för tjänstkontot på Adobe Developer.

Välj Service Account (JWT) i den vänstra navigeringen och välj sedan Generate JWT.

I textrutan under Generate custom JWT klistrar du in innehållet i den privata nyckel som du tidigare skapade när du lade till Platform API i tjänstkontot. Välj sedan Generate Token.

Sidan uppdateras för att visa den genererade JWT-filen tillsammans med ett exempel på ett cURL-kommando som gör att du kan generera en åtkomsttoken. I den här självstudiekursen väljer du Copy bredvid Generated JWT för att kopiera token till Urklipp.

Generera en åtkomsttoken

När du har genererat en JWT kan du använda den i ett API-anrop för att generera {ACCESS_TOKEN}. 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 plattforms-API:er.

Begäran

Följande begäran genererar en ny {ACCESS_TOKEN} baserat på autentiseringsuppgifterna som anges i nyttolasten. Den här slutpunkten godkänner endast formulärdata som sin nyttolast, och därför måste den få Content-Type-huvudet multipart/form-data.

code language-shell
curl -X POST https://ims-na1.adobelogin.com/ims/exchange/jwt \
  -H 'Content-Type: multipart/form-data' \
  -F 'client_id={API_KEY}' \
  -F 'client_secret={SECRET}' \
  -F 'jwt_token={JWT}'
table 0-row-2 1-row-2 2-row-2 3-row-2
Egenskap Beskrivning
{API_KEY} {API_KEY} (Client ID) som du hämtade i ett föregående steg.
{SECRET} Klienthemligheten som du hämtade i ett föregående steg.
{JWT} Den JWT som du genererade i ett föregående steg.
note note
NOTE
Du kan använda samma API-nyckel, klienthemlighet och JWT för att generera en ny åtkomsttoken för varje session. Detta gör att du kan automatisera genereringen av åtkomsttoken i dina program.

Svar

code language-json
{
  "token_type": "bearer",
  "access_token": "{ACCESS_TOKEN}",
  "expires_in": 86399992
}
table 0-row-2 1-row-2 2-row-2 3-row-2
Egenskap Beskrivning
token_type Typen of token returneras. För åtkomsttoken är det här värdet alltid bearer.
access_token Den genererade {ACCESS_TOKEN}. Det här värdet, som föregås av ordet Bearer, krävs som Authentication-rubrik för alla API-anrop för plattformen.
expires_in Antalet millisekunder som återstår tills åtkomsttoken upphör att gälla. När värdet når 0 måste en ny åtkomsttoken genereras för att du ska kunna fortsätta använda Platform API:er.

Testa autentiseringsuppgifter test-credentials

När du har samlat in alla tre nödvändiga autentiseringsuppgifter - åtkomsttoken, API-nyckel och organisations-ID - kan du försöka göra följande API-anrop. Det här samtalet listar alla Experience Data Model (XDM) standardklasser som är tillgängliga för din organisation. Importera och kör samtalet i Postman.

recommendation-more-help

Begäran

curl -X GET https://platform.adobe.io/data/foundation/schemaregistry/global/classes \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -H 'Authorization: Bearer {{ACCESS_TOKEN}}' \
  -H 'x-api-key: {{API_KEY}}' \
  -H 'x-gw-ims-org-id: {{ORG_ID}}'

Svar

Om ditt svar liknar det som visas nedan är dina inloggningsuppgifter giltiga och fungerar. (Det här svaret har trunkerats för utrymme.)

{
  "results": [
    {
        "title": "XDM ExperienceEvent",
        "$id": "https://ns.adobe.com/xdm/context/experienceevent",
        "meta:altId": "_xdm.context.experienceevent",
        "version": "1"
    },
    {
        "title": "XDM Individual Profile",
        "$id": "https://ns.adobe.com/xdm/context/profile",
        "meta:altId": "_xdm.context.profile",
        "version": "1"
    }
  ]
}
IMPORTANT
Samtalet ovan räcker för att testa dina inloggningsuppgifter, men tänk på att du inte kommer att kunna komma åt eller ändra flera resurser utan rätt attributbaserad åtkomstkontrollbehörighet. Läs mer i avsnittet Hämta de nödvändiga attributbaserade åtkomstkontrollsbehörigheterna nedan.

Skaffa nödvändiga attributbaserade behörigheter för åtkomstkontroll get-abac-permissions

Om du vill få åtkomst till eller ändra flera resurser i Experience Platform måste du ha rätt åtkomstkontrollbehörighet. Systemadministratörer kan ge dig de behörigheter du behöver. Mer information finns i avsnittet om att hantera API-autentiseringsuppgifter för en roll.

Detaljerad information om hur en systemadministratör kan ge de behörigheter som krävs för att få åtkomst till plattformsresurser via API finns också i videosjälvstudien nedan:

Använd Postman för att autentisera och testa API-anrop use-postman

Postman är ett populärt verktyg som gör att utvecklare kan utforska och testa RESTful-API:er. Du kan använda Experience Platform Postman-samlingar och miljöer för att snabba upp arbetet med Experience Platform API:er. Läs mer om att använda Postman i Experience Platform och komma igång med samlingar och miljöer.

Detaljerad information om hur du använder Postman med Experience Platform i samlingar och miljöer finns också i videosjälvstudierna nedan:

Hämta och importera en Postman-miljö att använda med Experience Platform API:er

Använd en Postman-samling för att generera åtkomsttoken

Hämta Identity Management Service Postman-samlingen och se videon nedan för att lära dig hur du genererar åtkomsttoken.

Hämta Postman-samlingar med Experience Platform API och interagera med API:erna

Systemadministratörer: Bevilja utvecklare och API-åtkomstkontroll med Experience Platform behörigheter grant-developer-and-api-access-control

NOTE
Det är bara systemadministratörer som kan visa och hantera API-autentiseringsuppgifter i behörigheter.

Innan du skapar integreringar på Adobe Developer Console måste ditt konto ha utvecklar- och användarbehörigheter för en produktprofil för Experience Platform i Adobe Admin Console.

Lägg till utvecklare i produktprofilen add-developers-to-product-profile

Gå till Admin Console och logga in med din Adobe ID.

Välj Products och sedan Adobe Experience Platform i produktlistan.

Produktlista på Admin Console

Välj AEP-Default-All-Users på fliken Product Profiles. Du kan också använda sökfältet för att söka efter produktprofilen genom att ange namnet.

Sök efter produktprofilen

Välj fliken Developers och välj sedan Add Developer.

Lägg till utvecklare från fliken Utvecklare

Ange utvecklarens Email or username. En giltig Email or username visar utvecklarinformationen. Välj Save.

Lägg till utvecklare via e-post eller användarnamn

Utvecklaren har lagts till och visas på fliken Developers.

Utvecklare listade på fliken Utvecklare

Tilldela API till en roll

En systemadministratör kan tilldela API:er till roller i användargränssnittet i Experience Platform.

Välj Permissions och rollen som du vill lägga till API:t i. Välj fliken API credentials och välj sedan Add API credentials.

Fliken API-autentiseringsuppgifter i den valda rollen

Välj det API som du vill lägga till i rollen och välj sedan Save.

Lista över tillgängliga API:er för markering

Du återgår till fliken API credentials, där det nya API:t listas.

Fliken API-autentiseringsuppgifter med nyligen tillagt API

Ytterligare resurser additional-resources

Se de ytterligare resurserna nedan för att få hjälp med att komma igång med Experience Platform API:er

Nästa steg next-steps

Genom att läsa det här dokumentet har du samlat in och testat dina autentiseringsuppgifter för plattforms-API:er. Du kan nu följa med i de exempel på API-anrop som finns i dokumentationen.

Förutom de autentiseringsvärden du har samlat in i den här självstudiekursen, kräver många Platform API:er även att en giltig {SANDBOX_NAME} anges som rubrik. Se översikten över sandlådor för mer information.

5741548a-2e07-44b3-9157-9c181502d0c5