Documentatie Experience Platform Overzicht van Experience Platform

Aan de slag met Adobe Experience Platform API's

Laatst bijgewerkt: 24 april 2025

Onderwerpen:
API

Gemaakt voor:

Ontwikkelaar

Adobe Experience Platform is ontwikkeld volgens een "API first"-filosofie. Met Experience Platform API's kunt u via programmacode elementaire CRUD-bewerkingen (Maken, Lezen, Bijwerken, Verwijderen) uitvoeren op gegevens, zoals het configureren van berekende kenmerken, het openen van gegevens/entiteiten, het exporteren van gegevens, het verwijderen van overbodige gegevens of batches, enzovoort.

De API's voor elke Experience Platform-service hebben allemaal dezelfde set verificatieheaders en gebruiken vergelijkbare syntaxis voor hun CRUD-bewerkingen. In de volgende handleiding worden de stappen beschreven die nodig zijn om aan de slag te gaan met Experience Platform API's.

Verificatie en kopteksten

Om vraag aan Experience Platform eindpunten met succes te maken, wordt u vereist om het authentificatieleerprogrammate voltooien. Als u de zelfstudie over verificatie voltooit, krijgt u de waarden voor elk van de vereiste headers in Experience Platform API-aanroepen, zoals hieronder wordt getoond:

Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {ORG_ID}

Sandbox-header

Alle bronnen in Experience Platform zijn geïsoleerd naar specifieke virtuele sandboxen. Aanvragen aan Experience Platform API's vereisen een header die de naam aangeeft van de sandbox waarin de bewerking plaatsvindt:

x-sandbox-name: {SANDBOX_NAME}

Voor meer informatie over zandbakken in Experience Platform, zie de documentatie van het zandbakoverzicht.

Koptekst van inhoudstype

Alle verzoeken met een lading in het verzoeklichaam (zoals POST, PUT, en de vraag van PATCH) moeten een Content-Type kopbal omvatten. Accepteerde waarden zijn specifiek voor elk API-eindpunt. Als een specifieke Content-Type waarde voor een eindpunt nodig is, zal zijn waarde in de voorbeeld API verzoeken worden getoond die door de worden verstrekt API gidsen voor de individuele diensten van Experience Platform.

Basisprincipes van Experience Platform API

Adobe Experience Platform API's maken gebruik van verschillende onderliggende technologieën en syntaxis die belangrijk zijn om te begrijpen voor een effectief beheer van Experience Platform-bronnen.

Om meer over de onderliggende API technologieën te leren gebruikt Experience Platform, met inbegrip van voorbeeld JSON schemavoorwerpen, bezoek de fundamentele Experience Platform APIgids.

Postman-verzamelingen voor Experience Platform API's

Postman is een samenwerkingsplatform voor API-ontwikkeling waarmee u omgevingen kunt instellen met vooraf ingestelde variabelen, API-verzamelingen kunt delen, CRUD-aanvragen kunt stroomlijnen en nog veel meer. De meeste Experience Platform API-services beschikken over Postman-verzamelingen die kunnen worden gebruikt als hulpmiddel bij het maken van API-aanroepen.

Meer over Postman met inbegrip van hoe te opstelling een milieu, een lijst van beschikbare inzamelingen, en hoe te om inzamelingen in te voeren, bezoek de documentatie van Postman van Experience Platform.

API-voorbeeldaanroepen lezen

De aanvraagindelingen zijn afhankelijk van de Experience Platform API die wordt gebruikt. De beste manier om te leren hoe te om uw API vraag te structureren is door naast de voorbeelden te volgen die in de documentatie voor de bepaalde dienst van Experience Platform worden verstrekt u gebruikt.

In de documentatie voor Experience Platform worden op twee verschillende manieren voorbeeld-API-aanroepen weergegeven. Eerst, wordt de vraag voorgesteld in zijn API formaat, een malplaatjevertegenwoordiging die slechts de verrichting (GET, POST, PUT, PATCH, DELETE) en het eindpunt toont dat (bijvoorbeeld, /global/classes) wordt gebruikt. Sommige malplaatjes tonen ook de plaats van variabelen helpen illustreren hoe een vraag, zoals GET /{VARIABLE}/classes/{ANOTHER_VARIABLE} zou moeten worden geformuleerd.

De vraag wordt dan getoond als cURL bevelen in a Verzoek, die de noodzakelijke kopballen en volledige "basisweg"nodig omvat om met API met succes in wisselwerking te staan. Het basispad moet vooraf aan alle eindpunten worden toegevoegd. Het bovengenoemde /global/classes -eindpunt wordt bijvoorbeeld https://platform.adobe.io/data/foundation/schemaregistry/global/classes . De API-indeling/het aanvraagpatroon wordt in de hele documentatie weergegeven en u zult het volledige pad gebruiken dat in de voorbeeldaanvraag wordt getoond wanneer u zelf een aanroep naar Experience Platform API's maakt.

Voorbeeld-API-aanvraag

Hieronder ziet u een voorbeeld-API-aanvraag die de indeling weergeeft die u in de documentatie zult tegenkomen.

API formaat

De API-indeling toont de bewerking (GET) en het eindpunt dat wordt gebruikt. Variabelen worden aangegeven met accolades (in dit geval {CONTAINER_ID} ).

GET /{CONTAINER_ID}/classes

Verzoek

In deze voorbeeldaanvraag krijgen de variabelen van de API-indeling de werkelijke waarden in het aanvraagpad. Bovendien, worden alle vereiste kopballen getoond als of waarden van de steekproefkopbal of variabelen waar de gevoelige informatie (zoals veiligheidstokens en toegangsIDs) zou moeten worden omvat.

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}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Reactie

De reactie illustreert wat u zou verwachten te ontvangen na een succesvolle vraag aan API, die op het verzoek wordt gebaseerd dat werd verzonden. Soms wordt de reactie afgebroken voor de ruimte, wat betekent dat u meer informatie of aanvullende informatie ziet voor de hoeveelheid die in het voorbeeld wordt weergegeven.

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

Foutberichten

De het oplossen van problemengids van Experience Platformverstrekt een lijst van fouten die u wanneer het gebruiken van om het even welke dienst van Experience Platform kunt ontmoeten.

Voor het oplossen van problemengidsen op de individuele diensten van Experience Platform, zie de folder van het de dienstoplossen van problemen.

Voor meer informatie over specifieke eindpunten in Experience Platform APIs, met inbegrip van vereiste kopballen en verzoekorganismen, gelieve te zien de Experience Platform API gidsen.

Experience Platform API-hulplijnen

API-handleiding

Beschrijving

Access Control API gids

Het API-eindpunt van Access Control kan het huidige beleid ophalen dat van kracht is voor een gebruiker op bepaalde bronnen binnen een opgegeven sandbox. Alle andere mogelijkheden van de toegangscontrole worden verstrekt door Adobe Admin Console.

Gids van de Inname van de Partij API

Met de Adobe Experience Platform Data Ingestion -API kunt u gegevens als batchbestanden in Experience Platform invoeren. Gegevens die worden opgenomen kunnen de profielgegevens van een vlak dossier in een systeem van CRM (zoals een dossier van het Pakket), of gegevens zijn die met een bekend schema in de Registratie van het Schema (XDM) in overeenstemming zijn.

Catalog Service API gids

Met de API van Catalog Service kunnen ontwikkelaars metagegevens van gegevenssets beheren in Adobe Experience Platform. Dit omvat gegevenslocaties, verwerkingsfasen, fouten die tijdens de verwerking zijn opgetreden en gegevensrapporten.

Data Access API gids

Met de API van Data Access kunnen ontwikkelaars informatie ophalen over ingesloten gegevenssets in Experience Platform. Hiertoe behoren het openen en downloaden van gegevenssetbestanden, het ophalen van koptekstgegevens, het opgeven van mislukte en opvolgende batches en het downloaden van voorvertoningen van CSV-/Parquet-bestanden.

Dataset Service API gids

Met de Dataset Service API kunt u gebruikslabels voor gegevenssets toepassen en bewerken. Deze klasse maakt deel uit van de mogelijkheden van de Adobe Experience Platform-gegevenscatalogus, maar staat los van de API van de Catalogusservice die metagegevens van gegevenssets beheert.

Data Hygiene API guide

Met de API van Data Hygiene kunt u via programmacode de opgeslagen persoonlijke gegevens van uw klanten in Adobe Experience Platform corrigeren of verwijderen. Ook kunt u de vervaldatums voor gegevenssets plannen.

Edge Network API gids

Edge Network API kan voor een verscheidenheid van gegevensinzameling, verpersoonlijking, reclame en marketing gebruiksgevallen worden gebruikt. Edge Network API kan op servers, IoT apparaten, reeks-hoogste dozen, en een verscheidenheid van andere apparaten worden gebruikt.

Identity Service API gids

Met de API van Identity Service kunnen ontwikkelaars de identificatie van uw klanten via verschillende apparaten, kanalen en in de buurt van realtime beheren met behulp van identiteitsgrafieken in Adobe Experience Platform.

MTLS Service API guide

Met de API van MTLS Service kunt u openbare certificaten die door Adobe voor uw organisatie zijn uitgegeven, veilig ophalen.

Observability Insights API gids

Observability Insights is een RESTful API die ontwikkelaars toestaat om zeer belangrijke waarneembaarheidsmetriek in Adobe Experience Platform bloot te stellen. Deze cijfers bieden inzicht in gebruiksstatistieken van Experience Platform, gezondheidscontroles voor Experience Platform-services, historische trends en prestatie-indicatoren voor verschillende functies van Experience Platform.

Policy Service API gids
(het Beheer van Gegevens)

Met de API van Policy Service kunt u labels en beleidsregels voor gegevensgebruik maken en beheren om te bepalen welke marketingacties kunnen worden uitgevoerd tegen gegevens die bepaalde labels voor gegevensgebruik bevatten. Om etiketten op datasets en gebieden toe te passen, verwijs naar Dataset Service APIgids

Privacy Service API gids

Met de API van Privacy Service kunnen ontwikkelaars hun verzoeken om toegang tot of verwijdering van hun persoonlijke gegevens in Experience Cloud-toepassingen maken en beheren, in overeenstemming met de wettelijke privacyregels.

Query Service API gids

Met de API van Query Service kunnen ontwikkelaars hun Adobe Experience Platform-gegevens opvragen met behulp van standaard SQL.

Real-Time Customer Profile API gids

Met de realtime-API voor klantprofiel kunnen ontwikkelaars profielgegevens verkennen en ermee werken, zoals het weergeven van profielen, het maken en bijwerken van samenvoegbeleid, het exporteren of samplen van profielgegevens en het verwijderen van profielgegevens die niet langer vereist zijn of die bij fout zijn toegevoegd.

zandbak API gids

Met de sandbox-API kunnen ontwikkelaars via programmacode geïsoleerde virtuele sandboxomgevingen in Adobe Experience Platform beheren.

Schema Registry API gids
(XDM)

Met de API van Schema Registry kunnen ontwikkelaars programmatisch alle schema's en gerelateerde XDM-bronnen (Experience Data Model) in Adobe Experience Platform beheren.

Segmentation Service API gids

Met de API van Segmentation Service kunnen ontwikkelaars segmentatiebewerkingen in Adobe Experience Platform programmatisch beheren. Dit omvat het bouwen van segmenten en het produceren van publiek van uw gegevens van het Profiel van de Klant in real time.

Sensei Machine Learning API gids
(de Wetenschap van Gegevens Workspace)

De API van Sensei Machine Learning verstrekt een mechanisme voor gegevenswetenschappers om machine het leren (ML) diensten van algoritme op het instappen, experimenteren, en aan de dienstplaatsing te organiseren en te beheren.

Voor meer informatie over specifieke eindpunten en verrichtingen beschikbaar voor elke dienst, te zien gelieve de API verwijzingsdocumentatieop Adobe I/O.

Volgende stappen

In dit document zijn de vereiste kopteksten, beschikbare hulplijnen en een voorbeeld-API-aanroep geïntroduceerd. Nu u de vereiste kopbalwaarden nodig hebt om API vraag op Adobe Experience Platform te maken, selecteer een API eindpunt u van de Experience Platform API gidsen lijstwenst te onderzoeken.

Voor antwoorden op vaak gestelde vragen, verwijs naar de het oplossen van problemengids van Experience Platform.

Om opstelling een milieu van Postman en de beschikbare inzamelingen van Postman te onderzoeken, verwijs naar de gids van Postman van Experience Platform.

recommendation-more-help