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

Contact opnemen met Admin Console beheerder in uw organisatie om u als ontwikkelaar aan een het productprofiel van het Experience Platform toe te voegen gebruikend Admin Console. Zie de Admin Console documentatie voor specifieke instructies over hoe te toegang voor ontwikkelaars beheren voor productprofielen.

Als u eenmaal als ontwikkelaar bent toegewezen, kunt u beginnen met het maken van integratie in Adobe Developer Console. 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 handleiding op gebruikersgroepen beheren in Admin Console voor meer informatie .

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

Nadat u ontwikkelaars en gebruikers toegang tot Platform door hebt gegeven Admin ConsoleDe volgende stap bestaat 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 Console en meld u aan met uw Adobe ID. Voer vervolgens de stappen uit die in de zelfstudie worden beschreven een leeg project maken in de Adobe Developer Console-documentatie.

Als u een nieuw project hebt gemaakt, selecteert u Add API op de Project Overview scherm.

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

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

Selecteer vervolgens het verificatietype dat u wilt maken voor het genereren van toegangstokens en voor toegang tot de Experience Platform-API.

Selecteer de productprofielen voor uw integratie select-product-profiles

In de Configure API scherm, selecteren AEP-Default-All-Users.

Selecteren 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 De pagina voor het project toont 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 platform API vraag. 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. Selecteren Generate access token, zoals hieronder weergegeven.

[Vervangen]{class="badge negative"} Een JSON-webtoken (JWT) genereren 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 norm Experience Data Model (XDM) klassen beschikbaar aan uw organisatie. De invoer en voert de vraag binnen uit Postman.

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

Antwoord

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. Systeembeheerders kunnen u de machtigingen die u nodig hebt. Meer informatie vindt u in de sectie over het beheren van 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

Postman is 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. Meer informatie over Postman gebruiken in Experience Platform en aan de slag gaan met verzamelingen en omgevingen.

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

Een Postman-omgeving downloaden en importeren voor gebruik met Experience Platform-API's

Een Postman-verzameling gebruiken om toegangstokens te genereren

Download de Identity Management Service Postman collection en bekijk de video hieronder om te leren hoe te om toegangstokens te produceren.

Postman-verzamelingen voor Experience Platform-API downloaden en communiceren met de API's

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

Voordat u integratie in 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 Console en meld u aan met uw Adobe ID.

Selecteren Products selecteert u vervolgens Adobe Experience Platform in de lijst van 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 Developers tab, dan selecteren Add Developer.

Voer de Email or username. Een geldige Email or username geeft de ontwikkelaardetails weer. Selecteer Save.

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

API aan een rol toewijzen

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

Selecteren Permissions en de rol waaraan u de API wilt toevoegen. Selecteer de API credentials tab, dan selecteren Add API credentials.

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

U bent teruggekeerd aan API credentials , waarin de nieuw 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 de voorbeeld-API-aanroepen volgen die via de documentatie.

Naast de authentificatiewaarden u in dit leerprogramma hebt verzameld, vereisen vele Platform APIs ook een geldig {SANDBOX_NAME} te verstrekken als koptekst. Zie het sandboxoverzicht voor meer informatie.