Komma igång med REST APIs getting-started-with-rest-apis

Adobe Developer - översikt adobeio

Adobe Developer är Adobe utvecklares ekosystem och community. Den innehåller API:er för alla Adobe-produkter.

Detta är det rekommenderade sättet att konfigurera och använda Adobe APIs.

Förutsättningar prerequisites

Innan du kan konfigurera JWT-autentisering måste du kontrollera att du har åtkomst till Adobe Developer Console i Adobe Developer. Kontakta din organisations administratör för åtkomstbegäranden.

Autentisering auth

Följ stegen nedan för att konfigurera JWT (Service Account)-autentisering med Adobe Developer:

1. Logga in på Adobe Developer Console.
2. Följ stegen i Anslutning till tjänstkonto.
   • Under Steg 2: Lägg till ett API i projektet med autentisering av tjänstkonto, välj alternativet Audience Manager API .
3. Prova anslutningen genom att ringa ditt första API-samtal baserat på instruktionerna från Steg 3.

RBAC-behörigheter för tekniskt konto

Om ditt Audience Manager-konto använder rollbaserad åtkomstkontroll måste du skapa ett Audience Manager-tekniskt användarkonto och lägga till det i Audience Manager RBAC-gruppen som gör API-anropen.

Följ stegen nedan för att skapa ett tekniskt användarkonto och lägga till det i en RBAC-grupp:

1. Ring GET till https://aam.adobe.io/v1/users/self. Anropet skapar ett tekniskt användarkonto som du kan se på sidan Admin Console på sidan Users.

   

2. Logga in på ditt Audience Manager-konto och lägg till det tekniska användarkontot i användargruppen som ska göra API-anropen.

Audience Manager REST API följer OAuth 2.0 standarder för tokenautentisering och förnyelse. I avsnitten nedan beskrivs hur du autentiserar och börjar arbeta med API.

Skapa en allmän API-användare requirements

Vi rekommenderar att du skapar ett separat, tekniskt användarkonto för att arbeta med Audience Manager APIs. Det här är ett generiskt konto som inte är kopplat till eller kopplat till en viss användare i organisationen. Den här typen av API-användarkonto hjälper dig att uppnå två saker:

• Identifiera vilken tjänst som anropar API (t.ex. samtal från dina appar som använder våra API eller från andra verktyg som gör API-förfrågningar).
• Ge oavbruten åtkomst till API. Ett konto som är knutet till en viss person kan tas bort när de lämnar företaget. Detta förhindrar dig från att arbeta med tillgänglig API-kod. Ett generiskt konto som inte är kopplat till en viss medarbetare hjälper dig att undvika det här problemet.

Ett exempel eller ett användningsfall för den här typen av konto är att du vill ändra många segment samtidigt med grupphanteringsverktygen. För att göra detta behöver ditt användarkonto API åtkomst. I stället för att lägga till behörigheter till en viss användare skapar du ett icke-specifikt API-användarkonto som har rätt autentiseringsuppgifter, nyckel och hemlighet för att ringa API-anrop. Detta är också användbart om du utvecklar egna program som använder Audience Manager APIs.

Arbeta med din Audience Manager-konsult för att konfigurera ett generiskt, API-skyddat användarkonto.

Lösenordsautentisering password-authentication-workflow

Lösenordsautentisering ger säker åtkomst till REST API. Stegen nedan visar arbetsflödet för lösenordsautentisering från en JSON-klient i webbläsaren.

Steg 1: Begär API åtkomst

Kontakta din Partner Solutions Manager. De ger dig ett API klient-ID och en hemlighet. ID:t och hemligheten autentiserar dig för API.

Obs! Om du vill få en uppdateringstoken anger du det när du begär åtkomst till API.

Steg 2: Begär token

Skicka en tokenbegäran med den önskade JSON-klienten. När du skapar begäran:

• Använd metoden POST för att anropa https://api.demdex.com/oauth/token.
• Konvertera ditt klient-ID och hemlighet till en base-64-kodad sträng. Separera ID:t och hemligheten med ett kolon under konverteringsprocessen. Autentiseringsuppgifterna testId : testSecret konverteras till exempel till dGVzdElkOnRlc3RTZWNyZXQ=.
• Skicka in HTTP headers Authorization:Basic <base-64 clientID:clientSecret> och Content-Type: application/x-www-form-urlencoded . Din rubrik kan till exempel se ut så här:
  Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
• Ställ in begärandetexten enligt följande:
  
  grant_type=password&username=<your-AudienceManager-user-name>&password=<your-AudienceManager-password>

Steg 3: Ta emot token

Svaret JSON innehåller din åtkomsttoken. Svaret bör se ut så här:

{
    "access_token": "28fed402-eafd-456c-9341-ac753f25bbbc",
    "token_type": "bearer",
    "refresh_token": "b27122c0-b0c7-4b39-a71b-1547a3b3b88e",
    "expires_in": 21922,
    "scope": "read write"
}

Nyckeln expires_in representerar antalet sekunder tills åtkomsttoken upphör att gälla. Som bästa praxis bör du använda korta förfallotider för att begränsa exponeringen om token någonsin exponeras.

Uppdatera token refresh-token

Uppdatera tokens förnya API-åtkomsten när den ursprungliga token har upphört att gälla. Om det efterfrågas innehåller svaret JSON i lösenordsarbetsflödet en uppdateringstoken. Om du inte får någon uppdateringstoken skapar du en ny under lösenordsautentiseringsprocessen.

Du kan också använda en uppdateringstoken för att generera en ny token innan den befintliga åtkomsttoken upphör att gälla.

Om din åtkomsttoken har upphört att gälla får du ett 401 Status Code och följande rubrik i svaret:

WWW-Authenticate: Bearer realm="oauth", error="invalid_token", error_description="Access token expired: <token>"

I följande steg beskrivs arbetsflödet för att använda en uppdateringstoken för att skapa en ny åtkomsttoken från en JSON-klient i webbläsaren.

Steg 1: Begär ny token

Skicka en begäran om uppdateringstoken med den önskade JSON-klienten. När du skapar begäran:

• Använd metoden POST för att anropa https://api.demdex.com/oauth/token.
• Konvertera ditt klient-ID och hemlighet till en base-64-kodad sträng. Separera ID:t och hemligheten med ett kolon under konverteringsprocessen. Autentiseringsuppgifterna testId : testSecret konverteras till exempel till dGVzdElkOnRlc3RTZWNyZXQ=.
• Skicka HTTP-rubrikerna Authorization:Basic <base-64 clientID:clientSecret> och Content-Type: application/x-www-form-urlencoded. Din rubrik kan till exempel se ut så här:
  Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
• Ange grant_type:refresh_token i begärandetexten och skicka den uppdateringstoken som du fick i din tidigare åtkomstbegäran. Begäran ska se ut så här:
  grant_type=refresh_token&refresh_token=b27122c0-b0c7-4b39-a71b-1547a3b3b88e

Steg 2: Ta emot den nya token

Svaret JSON innehåller din nya åtkomsttoken. Svaret bör se ut så här:

{
    "access_token": "4fdfc261-2ffc-4fb7-8dbd-64221714c45f",
    "token_type": "bearer",
    "refresh_token": "295fa487-1825-4caa-a715-80b81ac17dae",
    "expires_in": 21922,
    "scope": "read write"
}

Auktoriseringskod och implicit autentisering authentication-code-implicit

Audience Manager REST API stöder auktoriseringskod och implicit autentisering. Om du vill använda de här åtkomstmetoderna måste dina användare logga in på https://api.demdex.com/oauth/authorize för att få tillgång till och uppdatera tokens.