Aan de slag met REST APIs getting-started-with-rest-apis

Adobe Developer - Overzicht adobeio

Adobe Developer is het Adobe-ontwikkelaarsecosysteem en -gemeenschap. Het omvat APIs voor alle producten van Adobe.

Dit is de aanbevolen manier om Adobe APIs in te stellen en te gebruiken.

Vereisten prerequisites

Alvorens u JWT authentificatie kunt vormen, zorg ervoor u toegang tot Adobe Developer Consolein Adobe Developerhebt. Neem contact op met uw organisatiebeheerder voor verzoeken om toegang.

Verificatie auth

Voer de onderstaande stappen uit om JWT (Service Account) verificatie te configureren met Adobe Developer :

1. Login aan Adobe Developer Console.
2. Volg de stappen in Verbinding van de Rekening van de Dienst.
   • Tijdens Stap 2: voeg API aan uw project toe gebruikend de authentificatie van de Rekening van de Dienst, kies de Audience Manager API optie.
3. Probeer uit de verbinding door uw eerste API vraag te maken die op de instructies van wordt gebaseerd Stap 3.

Machtigingen voor RBAC's van technische rekeningen

Als uw Audience Manager rekening Op rol-Gebaseerd Toegangsbeheergebruikt, moet u een Audience Manager technische gebruikersrekening tot stand brengen en het toevoegen aan de groep van Audience Manager RBAC die de API vraag zal maken.

Voer de onderstaande stappen uit om een technische gebruikersaccount te maken en deze toe te voegen aan een RBAC-groep:

1. Roep GET aan https://aam.adobe.io/v1/users/self . Met de aanroep wordt een technische gebruikersaccount gemaakt die u kunt zien op de pagina Admin Console in Users .

   

2. Login aan uw rekening van Audience Manager en voeg de technische gebruikersrekeningaan de gebruikersgroep toe die de API vraag zal maken.

De Audience Manager REST API volgt OAuth 2.0 -standaarden voor tokenverificatie en -vernieuwing. De secties beschrijven hieronder om voor authentiek te verklaren en beginnen werkend met API s.

Een algemene API gebruiker maken requirements

Wij adviseren u een afzonderlijke, technische gebruikersrekening voor het werken met Audience Manager tot stand brengen API s. Dit is een generieke account die niet is gekoppeld aan of gekoppeld aan een specifieke gebruiker in uw organisatie. Met dit type API -gebruikersaccount kunt u twee dingen doen:

• Identificeer welke dienst API roept (b.v., vraag van uw apps die onze API s of van andere hulpmiddelen gebruiken die API verzoeken indienen).
• Verstrek ononderbroken toegang tot API s. Een account die aan een bepaalde persoon is gekoppeld, kan worden verwijderd wanneer deze uw bedrijf verlaat. Zo voorkomt u dat u met de beschikbare API -code werkt. Met een algemene account die niet aan een bepaalde werknemer is gekoppeld, voorkomt u dit probleem.

Als voorbeeld of gebruiksgeval voor dit type van rekening, zeg u een hoop segmenten meteen met de Hulpmiddelen van het Beheer van het Bulkwilt veranderen. Uw gebruikersaccount heeft hiervoor API toegang nodig. In plaats van machtigingen toe te voegen aan een specifieke gebruiker, maakt u een niet-specifieke API gebruikersaccount met de juiste referenties, sleutel en geheim om API -aanroepen uit te voeren. Dit is ook nuttig als u uw eigen toepassingen ontwikkelt die Audience Manager gebruiken API s.

Werk samen met uw Audience Manager -consultant om een algemene API -gebruikersaccount in te stellen.

Workflow voor wachtwoordverificatie password-authentication-workflow

Wachtwoordverificatie is beveiligd met toegang tot onze REST API . In de onderstaande stappen wordt een overzicht gegeven van de workflow voor wachtwoordverificatie van een JSON -client in uw browser.

Stap 1: Toegang aanvragen API

Contacteer uw manager van de Oplossingen van de Partner. Ze geven u een API client-id en een geheim. De id en het geheim verifiëren u aan API.

Opmerking: als u een token voor vernieuwen wilt ontvangen, geeft u dat op wanneer u API toegang aanvraagt.

Stap 2: De token aanvragen

Geef een symbolische aanvraag door met de voorkeursclient JSON . Wanneer u het verzoek bouwt:

• Gebruik een methode POST om https://api.demdex.com/oauth/token aan te roepen.
• Zet uw cliënt ID en geheim in een basis-64 gecodeerde koord om. Scheid de id en het geheim tijdens het conversieproces met een dubbele punt. De gegevens testId : testSecret worden bijvoorbeeld omgezet in dGVzdElkOnRlc3RTZWNyZXQ= .
• Geef de HTTP headers Authorization:Basic <base-64 clientID:clientSecret> en Content-Type: application/x-www-form-urlencoded door. De koptekst kan er bijvoorbeeld als volgt uitzien:
  Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
• Stel de aanvraaginstantie als volgt in:
  
  grant_type=password&username=<your-AudienceManager-user-name>&password=<your-AudienceManager-password>

Stap 3: Ontvang het token

De reactie JSON bevat uw toegangstoken. De reactie moet er als volgt uitzien:

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

De sleutel expires_in vertegenwoordigt het aantal seconden tot het toegangstoken verloopt. U kunt het beste korte vervaltijden gebruiken om de belichting te beperken als het token ooit wordt blootgesteld.

Token vernieuwen refresh-token

Tokens vernieuwen vernieuwt API de toegang nadat het oorspronkelijke token is verlopen. Indien gevraagd, bevat de reactie JSON in de wachtwoordworkflow een token voor vernieuwen. Als u ontvangt vernieuw symbolisch, creeer nieuwe door het proces van de wachtwoordauthentificatie.

U kunt ook een vernieuwingstoken gebruiken om een nieuw token te genereren voordat het bestaande toegangstoken verloopt.

Als uw toegangstoken is verlopen, ontvangt u een 401 Status Code en de volgende kopbal in de reactie:

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

In de volgende stappen wordt een overzicht gegeven van de workflow voor het gebruik van een vernieuwingstoken om een nieuw toegangstoken te maken van een JSON -client in uw browser.

Stap 1: Nieuwe token aanvragen

Geef een vernieuwingstoken-aanvraag door aan uw voorkeursclient JSON . Wanneer u het verzoek bouwt:

• Gebruik een methode POST om https://api.demdex.com/oauth/token aan te roepen.
• Zet uw cliënt ID en geheim in een basis-64 gecodeerde koord om. Scheid de id en het geheim tijdens het conversieproces met een dubbele punt. De gegevens testId : testSecret worden bijvoorbeeld omgezet in dGVzdElkOnRlc3RTZWNyZXQ= .
• Geef de HTTP-headers Authorization:Basic <base-64 clientID:clientSecret> en Content-Type: application/x-www-form-urlencoded door. De koptekst kan er bijvoorbeeld als volgt uitzien:
  Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
• In het aanvraaglichaam, specificeer grant_type:refresh_token en ga in vernieuwt token over u in uw vorige toegangsverzoek ontving. De aanvraag moet er als volgt uitzien:
  grant_type=refresh_token&refresh_token=b27122c0-b0c7-4b39-a71b-1547a3b3b88e

Stap 2: Ontvang het Nieuwe Token

De reactie JSON bevat uw nieuwe toegangstoken. De reactie moet er als volgt uitzien:

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

Autorisatiecode en impliciete verificatie authentication-code-implicit

Audience Manager REST API ondersteunt machtigingscode en impliciete verificatie. Als u deze toegangsmethoden wilt gebruiken, moeten uw gebruikers zich aanmelden bij https://api.demdex.com/oauth/authorize om toegang te krijgen tot tokens en deze te vernieuwen.