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:

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:

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:

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

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.

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

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

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

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:

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.

Skapa och hämta autentiseringsuppgifter direkt i API-referensdokumentationen get-credentials-functionality

Från och med november 2024-utgåvan av Experience Platform kan du få autentiseringsuppgifter för att använda API:erna för Experience Platform direkt från API:ts referenssidor, utan att behöva gå till Developer Console. Visa exemplet nedan från Flow Service API - Destinations-sidan.

Om du vill ha inloggningsuppgifter för att anropa API:er för plattformar går du till en Experience Platform API-referenssida och väljer Sign in högst upp på sidan. Logga in med din Personal Account eller Company or School Account.

När du har loggat in väljer du Create new credential för att skapa en ny uppsättning autentiseringsuppgifter för att komma åt plattforms-API:er.

Använd sedan listruteväljaren för att öppna inloggningsfönstret, generera en åtkomsttoken och hämta API-nyckeln och ditt organisations-ID. Kopiera autentiseringsuppgifterna till Try it-blocken på API-referenssidorna för att börja arbeta med plattforms-API:er.

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

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}'

{
  "token_type": "bearer",
  "access_token": "{ACCESS_TOKEN}",
  "expires_in": 86399992
}

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.

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"
    }
  ]
}

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

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.

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.

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

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

Utvecklaren har lagts till och visas på fliken Developers.

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.

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

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

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.