Aan de slag met Adobe Experience Platform API's

Adobe Experience Platform is ontwikkeld volgens een "API first"-filosofie. Met 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 en meer.

De APIs voor elke dienst van het Experience Platform delen allen de zelfde reeks authentificatiekopballen en gebruiken gelijkaardige syntaxis voor hun verrichtingen CRUD. In de volgende handleiding worden de stappen beschreven die nodig zijn om aan de slag te gaan met platform-API's.

Verificatie en kopteksten

Om met succes vraag aan de eindpunten van het Platform te maken, moet u voltooien verificatiezelfstudie. Het voltooien van de autorisatiezelfstudie biedt de waarden voor elk van de vereiste headers in Experience Platform API-aanroepen, zoals hieronder wordt getoond:

Sandbox-header

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

Voor meer informatie over sandboxen in Platform raadpleegt u de overzichtsdocumentatie van sandbox.

Koptekst van inhoudstype

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

Grondbeginselen van Experience Platform API

Adobe Experience Platform API's maken gebruik van verschillende onderliggende technologieën en syntaxis die belangrijk zijn om te begrijpen, zodat de resources van het platform effectief kunnen worden beheerd.

Ga voor meer informatie over de onderliggende API-technologieën die het Platform gebruikt, waaronder JSON-schemaobjecten, naar de Grondbeginselen van Experience Platform API hulplijn.

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 Platform API-services hebben Postman-verzamelingen die kunnen worden gebruikt om te helpen bij het maken van API-aanroepen.

Ga voor meer informatie over Postman, zoals het instellen van een omgeving, een lijst met beschikbare verzamelingen en het importeren van verzamelingen naar de Platform Postman-documentatie.

API-voorbeeldaanroepen lezen sample-api

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

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

De vraag wordt dan getoond als cURL bevelen in a Verzoek, die de vereiste headers en het volledige 'basispad' bevat die nodig zijn om de API te gebruiken. Het basispad moet vooraf aan alle eindpunten worden toegevoegd. Bijvoorbeeld: /global/classes eindpunt wordt https://platform.adobe.io/data/foundation/schemaregistry/global/classes. U zult het formaat van API/verzoekpatroon door de documentatie zien, en zal naar verwachting de volledige weg gebruiken die in het voorbeeldverzoek wordt getoond wanneer het maken van uw eigen vraag aan Platform APIs.

Voorbeeld-API-aanvraag

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

API-indeling

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

Antwoord

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 Handleiding voor probleemoplossing voor platforms verstrekt een lijst van fouten die u wanneer het gebruiken van om het even welke dienst van het Experience Platform kunt ontmoeten.

Voor het oplossen van problemengidsen op de individuele diensten van het Platform, zie servicemap voor probleemoplossing.

Voor meer informatie over specifieke eindpunten in platform APIs, met inbegrip van vereiste kopballen en aanvraaginstanties, gelieve te zien Platform API-hulplijnen.

Platform API-hulplijnen api-guides

Voor meer informatie over specifieke eindpunten en verrichtingen beschikbaar voor elke dienst, gelieve te zien API-naslagdocumentatie op 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 headerwaarden hebt om API-aanroepen uit te voeren op Adobe Experience Platform, selecteert u een API-eindpunt dat u wilt verkennen in het dialoogvenster Tabel met API-hulplijnen voor platforms.

Voor antwoorden op veelgestelde vragen raadpleegt u de Handleiding voor probleemoplossing voor platforms.

Als u een Postman-omgeving wilt instellen en de beschikbare Postman-verzamelingen wilt bekijken, raadpleegt u de Platform Postman-gids.