Experience Platform-API's verifiëren en openen

Dit document biedt een stapsgewijze zelfstudie voor het verkrijgen van toegang tot een Adobe Experience Platform-ontwikkelaarsaccount om aanroepen uit te voeren naar Experience Platform-API's. Aan het einde van deze zelfstudie hebt u de volgende gegevens gegenereerd of verzameld die als headers zijn vereist voor alle API-aanroepen van het platform:

Om de veiligheid van uw toepassingen en gebruikers te handhaven, moeten alle verzoeken aan Experience Platform APIs worden voor authentiek verklaard en worden gemachtigd gebruikend normen zoals OAuth.

In deze zelfstudie wordt uitgelegd hoe u de vereiste referenties kunt verzamelen voor het verifiëren van API-aanroepen van het platform, zoals hieronder in het stroomschema wordt beschreven. U kunt de meeste vereiste geloofsbrieven in eerste éénmalige opstelling verzamelen. Het toegangstoken, echter, moet om de 24 uur worden verfrist.

Vereisten prerequisites

Om met succes vraag aan Experience Platform APIs te maken, moet u het volgende hebben:

U moet ook over een Adobe ID beschikken om deze zelfstudie te voltooien. Als u geen Adobe ID hebt, kunt u er een maken door de volgende stappen uit te voeren:

De ontwikkelaar van de winst en gebruikerstoegang voor Experience Platform gain-developer-user-access

Voordat u integratie op Adobe Developer Console kunt maken, moet uw account ontwikkelings- en gebruikersmachtigingen hebben voor een productprofiel voor een Experience Platform in Adobe Admin Console.

Toegang voor ontwikkelaars verkrijgen gain-developer-access

Neem contact op met een Admin Console beheerder in uw organisatie om u als ontwikkelaar toe te voegen aan een productprofiel van een Experience Platform met behulp van Admin Console. Zie de Admin Console documentatie voor specifieke instructies op hoe te ontwikkelaarstoegang voor productprofielenbeheren.

Zodra u als ontwikkelaar wordt toegewezen, kunt u beginnen integraties in Adobe Developer Consoletot stand te brengen. Deze integratie vormt een pijplijn van externe apps en services naar Adobe-API's.

Toegang tot gebruikers verkrijgen gain-user-access

Uw Admin Console -beheerder moet u ook als gebruiker toevoegen aan hetzelfde productprofiel. Met gebruikerstoegang, kunt u in UI het resultaat van de API verrichtingen zien die u uitvoert.

Zie de gids op het leiden gebruikersgroepen in Admin Consolevoor meer informatie.

Een API-sleutel (client-id) en organisatie-id genereren generate-credentials

Nadat u ontwikkelaars en gebruikers via Admin Console toegang hebt verleend tot Platform, bestaat de volgende stap uit het genereren van uw {ORG_ID} - en {API_KEY} -referenties in Adobe Developer Console. Deze geloofsbrieven moeten slechts eenmaal worden geproduceerd en kunnen in toekomstige vraag van Platform API worden opnieuw gebruikt.

Experience Platform toevoegen aan een project add-platform-to-project

Ga naar Adobe Developer Consoleen teken binnen met uw Adobe ID. Daarna, volg de stappen die in het leerprogramma worden geschetst op creërend een leeg projectin de documentatie van Adobe Developer Console.

Wanneer u een nieuw project hebt gemaakt, selecteert u Add API op het Project Overview -scherm.

Het scherm Add an API wordt weergegeven. Selecteer het productpictogram voor Adobe Experience Platform en kies vervolgens Experience Platform API voordat u Next selecteert.

Selecteer het verificatietype OAuth Server-to-Server select-oauth-server-to-server

Selecteer vervolgens het verificatietype OAuth Server-to-Server dat u wilt gebruiken voor het genereren van toegangstokens en het openen van de Experience Platform-API.

Selecteer de productprofielen voor uw integratie select-product-profiles

Selecteer AEP-Default-All-Users in het Configure API -scherm.

Selecteer Save configured API wanneer u klaar bent.

In de onderstaande videozelfstudie vindt u een analyse van de hierboven beschreven stappen voor het instellen van integratie met de Experience Platform-API:

Referenties verzamelen gather-credentials

Zodra API aan het project is toegevoegd, Experience Platform API toont de pagina voor het project de volgende geloofsbrieven die in alle vraag aan Experience Platform APIs worden vereist:

Een toegangstoken genereren generate-access-token

De volgende stap bestaat uit het genereren van een {ACCESS_TOKEN} -referentie voor gebruik in API-aanroepen van het platform. In tegenstelling tot de waarden voor {API_KEY} en {ORG_ID} , moet om de 24 uur een nieuw token worden gegenereerd om door te gaan met het gebruik van platform-API's. Selecteer Generate access token, zoals hieronder wordt weergegeven.

te produceren

Verificatiegegevens rechtstreeks in de API-naslagdocumentatie maken en ophalen get-credentials-functionality

Vanaf de release van november 2024 van Experience Platform kunt u referenties ophalen om de Experience Platform-API's rechtstreeks vanaf de API-referentiepagina's te gebruiken, zonder dat u naar Developer Console hoeft te gaan. Bekijk het voorbeeld hieronder van de Dienst API van de Stroom - de pagina van Doelen.

Als u referenties wilt ophalen om Platform API's aan te roepen, navigeert u naar een willekeurige API-referentiepagina voor Experience Platforms en selecteert u Sign in boven aan de pagina. Meld u aan met uw Personal Account of Company or School Account .

Nadat u zich hebt aangemeld, selecteert u Create new credential om een nieuwe set referenties te maken voor toegang tot API's van het platform.

Gebruik vervolgens de keuzelijst om het venster met referenties te openen, een toegangstoken te genereren en uw API-sleutel en organisatie-id op te halen. Kopieer de referenties naar de blokken Try it op de API-referentiepagina's om te gaan werken met platform-API's.

[​ Vervangen ​]{class="badge informative"} {type=negative} produceer een Symbolisch van het Web JSON (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
}

Toegangsreferenties testen test-credentials

Nadat u alle drie vereiste gegevens hebt verzameld (toegangstoken, API-sleutel en organisatie-id), kunt u de volgende API-aanroep proberen te maken. Deze vraag maakt een lijst van alle standaard Experience Data Model (XDM) klassen beschikbaar aan uw organisatie. De invoer en voert de vraag in Postmanuit.

Verzoek

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

Reactie

Als uw reactie vergelijkbaar is met de hieronder weergegeven reactie, zijn uw gegevens geldig en werken ze. (Deze reactie is afgebroken voor de ruimte.)

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

Krijg de noodzakelijke op attributen-gebaseerde toegangsbeheertoestemmingen get-abac-permissions

Om tot verscheidene middelen binnen Experience Platform toegang te hebben of te wijzigen, moet u de aangewezen toestemmingen van de toegangscontrole hebben. De beheerders van het systeem kunnen u de toestemmingen verlenen unodig hebt. Krijg meer informatie in de sectie over het leiden API geloofsbrieven voor een rol.

De gedetailleerde informatie over hoe een systeembeheerder de vereiste toestemmingen kan verlenen om tot de middelen van het Platform via API toegang te hebben is ook beschikbaar in de videozelfstudie hieronder:

Postman gebruiken om API-aanroepen te verifiëren en te testen use-postman

Postmanis een populair hulpmiddel dat ontwikkelaars toestaat om RESTful APIs te onderzoeken en te testen. U kunt Experience Platform Postman-verzamelingen en -omgevingen gebruiken om uw werk met Experience Platform-API's te versnellen. Lees meer over het gebruiken van Postman in Experience Platformen het worden begonnen met inzamelingen en milieu's.

Gedetailleerde informatie over het gebruik van Postman met verzamelingen Experience Platforms en omgevingen is ook beschikbaar in de onderstaande videozelfstudies:

Download en voer een milieu van Postman in om met Experience Platform APIs te gebruiken

Gebruik een inzameling van Postman om toegangstokens te produceren

Download de inzameling van Postman van de Dienst van Identity Managementen bekijk de video hieronder om te leren hoe te om toegangstokens te produceren.

de inzamelingen van Postman van het Experience Platform API van de Download en interactie met APIs

Systeembeheerders: toegangsbeheer voor ontwikkelaars en API's verlenen met machtigingen voor Experience Platforms grant-developer-and-api-access-control

Voordat u integratie op Adobe Developer Console kunt maken, moet uw account ontwikkelings- en gebruikersmachtigingen hebben voor een productprofiel voor een Experience Platform in Adobe Admin Console.

Ontwikkelaars toevoegen aan productprofiel add-developers-to-product-profile

Ga naar Admin Consoleen meld u aan met uw Adobe ID.

Selecteer Products en selecteer vervolgens Adobe Experience Platform in de lijst met producten.

Selecteer op het tabblad Product Profiles de optie AEP-Default-All-Users . U kunt ook de zoekbalk gebruiken om het productprofiel te zoeken door de naam in te voeren.

Selecteer de tab Developers en selecteer vervolgens Add Developer .

toe

Voer de naam Email or username van de ontwikkelaar in. Een geldige Email or username geeft de details van de ontwikkelaar weer. Selecteer Save.

De ontwikkelaar is toegevoegd en wordt weergegeven op het tabblad Developers .

worden vermeld

API aan een rol toewijzen

Een systeembeheerder kan APIs aan rollen in het Experience Platform UI toewijzen.

Selecteer Permissions en de rol waaraan u de API wilt toevoegen. Selecteer de tab API credentials en selecteer vervolgens Add API credentials .

Selecteer de API die u aan de rol wilt toevoegen en selecteer vervolgens Save .

U wordt teruggestuurd naar het tabblad API credentials , waar de zojuist toegevoegde API wordt weergegeven.

Aanvullende bronnen additional-resources

Raadpleeg de aanvullende bronnen die hieronder zijn gekoppeld voor meer hulp bij het starten met Experience Platform-API's

Volgende stappen next-steps

Door dit document te lezen, hebt u uw toegangsreferenties voor platform-API's verzameld en getest. U kunt nu samen met de voorbeeld API vraag volgen die door de documentatiewordt verstrekt.

Naast de verificatiewaarden die u hebt verzameld in deze zelfstudie, vereisen veel platform-API's ook een geldige {SANDBOX_NAME} die als header moet worden verschaft. Zie het sandboxoverzicht voor meer informatie.