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:

  • {ACCESS_TOKEN}
  • {API_KEY}
  • {ORG_ID}
TIP
Naast de drie bovenstaande referenties, vereisen veel platform-API's ook een geldig {SANDBOX_NAME} dat als header moet worden opgegeven. Zie het zandbakenoverzichtvoor meer informatie over zandbakken en het zandbakbeheereindpuntdocumentatie voor informatie over het van een lijst maken van de zandbakken beschikbaar aan uw organisatie.

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:

  • Een organisatie met toegang tot Adobe Experience Platform.
  • Een beheerder van de Admin Console die u als ontwikkelaar en gebruiker voor een productprofiel kan toevoegen.
  • Een systeembeheerder van het Experience Platform die u de noodzakelijke attribuut gebaseerde toegangscontroles kan verlenen om gelezen uit te voeren of verrichtingen op verschillende delen van Experience Platform door APIs te schrijven.

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:

  1. Ga naar Adobe Developer Console.
  2. Selecteer Create a new account.
  3. Voltooi het aanmeldingsproces.

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

NOTE
Als u dit document van de Privacy Service API gidsvolgt, kunt u aan die gids nu terugkeren om de toegangsgeloofsbrieven te produceren uniek aan Privacy Service.

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.

TIP
Als u provisioned voor verscheidene organisaties bent, gebruik de organisatieselecteur in de hogere juiste hoek van de interface om ervoor te zorgen dat u in de organisatie bent u nodig hebt.

het scherm van Developer Console met Add wordt benadrukt API optie.

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

Uitgezochte Experience Platform API.

TIP
Selecteer de View docs optie om in een afzonderlijk browser venster aan de volledige Experience Platform API verwijzingsdocumentatiete navigeren.

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.

IMPORTANT
De methode OAuth Server-to-Server is de enige ondersteunde methode voor het genereren van tokens die vooruit gaat. De eerder ondersteunde Service Account (JWT) -methode is vervangen en kan niet worden geselecteerd voor nieuwe integraties. Hoewel bestaande integratie met behulp van de JWT-verificatiemethode tot 1 januari 2025 blijft werken, wordt in de Adobe ten zeerste aanbevolen dat u voor die datum bestaande integratie naar de nieuwe OAuth Server-to-Server -methode migreert. Krijg meer informatie in de sectie [​ Afgekeurd ​]{class="badge negative"} produceer een Token van het Web JSON (JWT).

selecteer de Server-aan-Server authentificatiemethode OAuth voor het Experience Platform API.

Selecteer de productprofielen voor uw integratie select-product-profiles

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

IMPORTANT
Om toegang tot bepaalde eigenschappen in Platform te krijgen, hebt u ook een systeembeheerder nodig om u de noodzakelijke op attribuut-gebaseerde toegangsbeheertoestemmingen te verlenen. Lees meer in de sectie krijgt de noodzakelijke op attributen-gebaseerde toegangsbeheertoestemmingen.

Uitgezochte productprofielen voor uw integratie.

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:

de informatie van de Integratie na het toevoegen van API in de Console van de Ontwikkelaar.

  • {API_KEY} (Client ID)
  • {ORG_ID} (Organization ID)

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.

toon hoe te om toegangstoken te produceren

TIP
U kunt ook een Postman-omgeving en -verzameling gebruiken om toegangstokens te genereren. Voor meer informatie, lees de sectie over gebruikend Postman om API vraagvoor authentiek te verklaren en te testen.

[​ Vervangen ​]{class="badge informative"} {type=negative} produceer een Symbolisch van het Web JSON (JWT) jwt

WARNING
De JWT-methode voor het genereren van toegangstokens is afgekeurd. Alle nieuwe integraties moeten worden gecreeerd gebruikend de Server-aan-Server authentificatiemethode. Adobe vereist ook dat u uw bestaande integraties aan de methode OAuth vóór 1 Januari, 2025 voor uw integraties om verder te werken migreert. Lees de volgende belangrijke documentatie:
Vervangen gegevens weergeven

De volgende stap bestaat uit het genereren van een JSON Web Token (JWT) op basis van uw accountgegevens. Deze waarde wordt gebruikt om uw {ACCESS_TOKEN} referentie te genereren voor gebruik in API-aanroepen van het platform, die elke 24 uur opnieuw moet worden gegenereerd.

note important
IMPORTANT
In deze zelfstudie wordt beschreven hoe u een JWT kunt genereren in Developer Console. Deze generatiemethode mag echter alleen voor test- en evaluatiedoeleinden worden gebruikt.
Voor normaal gebruik moet de JWT automatisch worden gegenereerd. Voor meer informatie over hoe te om JWTs programmatically te produceren, zie de gids van de de authentificatieauthentificatie van de de dienstrekeningop Adobe Developer.

Selecteer Service Account (JWT) in de linkernavigatie en selecteer vervolgens Generate JWT .

Plak in het tekstvak onder Generate custom JWT de inhoud van de persoonlijke sleutel die u eerder hebt gegenereerd toen u de platform-API aan uw serviceaccount toevoegde. Selecteer vervolgens Generate Token .

De pagina wordt bijgewerkt om de gegenereerde JWT weer te geven, samen met een voorbeeld-URL-opdracht waarmee u een toegangstoken kunt genereren. In deze zelfstudie selecteert u Copy naast Generated JWT om de token naar het klembord te kopiëren.

produceer een toegangstoken

Nadat u een JWT hebt gegenereerd, kunt u deze in een API-aanroep gebruiken om de {ACCESS_TOKEN} -aanroep te genereren. 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.

Verzoek

Het volgende verzoek genereert een nieuwe {ACCESS_TOKEN} op basis van de referenties die in de payload zijn opgegeven. Dit eindpunt accepteert alleen formuliergegevens als nuttige last en daarom moet het een Content-Type header van multipart/form-data krijgen.

code language-shell
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}'
table 0-row-2 1-row-2 2-row-2 3-row-2
Eigenschap Beschrijving
{API_KEY} {API_KEY} (Client ID) die u in a vorige stapterugwende.
{SECRET} Het cliëntgeheim dat u in a vorige stapterughaalde.
{JWT} JWT die u in a vorige stapproduceerde.
note note
NOTE
U kunt dezelfde API-sleutel, clientgeheim en JWT gebruiken om een nieuw toegangstoken voor elke sessie te genereren. Hierdoor kunt u het genereren van toegangstoken in uw toepassingen automatiseren.

Reactie

code language-json
{
  "token_type": "bearer",
  "access_token": "{ACCESS_TOKEN}",
  "expires_in": 86399992
}
table 0-row-2 1-row-2 2-row-2 3-row-2
Eigenschap Beschrijving
token_type Het type of token dat wordt geretourneerd. Voor toegangstokens is deze waarde altijd bearer .
access_token De gegenereerde {ACCESS_TOKEN} . Deze waarde, voorafgegaan door het woord Bearer , is vereist als de Authentication -header voor alle API-aanroepen van Platform.
expires_in Het aantal milliseconden dat resteert tot het toegangstoken verloopt. Zodra deze waarde 0 bereikt, moet een nieuw toegangstoken worden geproduceerd om het blijven gebruiken van Platform APIs.

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.

recommendation-more-help

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"
    }
  ]
}
IMPORTANT
Terwijl de vraag hierboven volstaat om uw toegangsgeloofsbrieven te testen, ben zich ervan bewust dat u niet tot verscheidene middelen zult kunnen toegang hebben of wijzigen zonder het hebben van de juiste op attribuut-gebaseerde toegangsbeheertoestemmingen. Lees meer in krijgt de noodzakelijke op attributen-gebaseerde toestemmingen van de toegangscontrole hieronder sectie.

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

NOTE
Alleen systeembeheerders kunnen API-referenties weergeven en beheren in Machtigingen.

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.

lijst van Producten op Admin Console

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.

Onderzoek naar het productprofiel

Selecteer de tab Developers en selecteer vervolgens Add Developer .

voeg ontwikkelaar van het lusje van Ontwikkelaars 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.

voeg ontwikkelaar toe gebruikend hun e-mail of gebruikersbenaming

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

Ontwikkelaars die op het lusje van Ontwikkelaars 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 .

API geloofsbrieven tabel in geselecteerde rol

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

Lijst van API beschikbaar voor selectie

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

API geloofsbrieven tabel met onlangs toegevoegde API

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.

5741548a-2e07-44b3-9157-9c181502d0c5