Komma igång med Adobe Experience Platform API:er

Adobe Experience Platform utvecklas under en"API first"-filosofi. Med Experience Platform API:er kan du programmässigt utföra grundläggande CRUD-åtgärder (Skapa, Läs, Uppdatera, Ta bort) mot data, till exempel konfigurera beräknade attribut, komma åt data/enheter, exportera data, ta bort onödiga data eller batchar med mera.

API:erna för varje Experience Platform-tjänst har alla samma uppsättning autentiseringsrubriker och använder liknande syntax för sina CRUD-åtgärder. Följande guide beskriver de steg som krävs för att komma igång med Experience Platform API:er.

Autentisering och rubriker

Du måste slutföra autentiseringssjälvstudiekursen för att kunna ringa anrop till Experience Platform-slutpunkter. När du är klar med självstudiekursen för autentisering visas värdena för var och en av de obligatoriska rubrikerna i Experience Platform API-anrop, vilket visas nedan:

Sandlådehuvud

Alla resurser i Experience Platform är isolerade till specifika virtuella sandlådor. Begäranden till Experience Platform API:er kräver en rubrik som anger namnet på sandlådan som åtgärden ska utföras i:

Mer information om sandlådor i Experience Platform finns i översiktsdokumentationen för sandlådan.

Rubrik för innehållstyp

Alla begäranden med en nyttolast i begärandetexten (som POST-, PUT- och PATCH-anrop) måste innehålla en Content-Type-rubrik. Godkända värden är specifika för varje API-slutpunkt. Om ett specifikt Content-Type-värde krävs för en slutpunkt visas dess värde i de exempel-API-begäranden som tillhandahålls av API-guiderna för enskilda Experience Platform-tjänster.

Grundläggande om Experience Platform API

Adobe Experience Platform API:er använder flera underliggande tekniker och syntaxer som är viktiga att förstå för att effektivt hantera Experience Platform resurser.

Mer information om de underliggande API-teknikerna som Experience Platform använder, inklusive exempel på JSON-schemaobjekt, finns i guiden Grundläggande om Experience Platform API.

Postman-samlingar för Experience Platform API:er

Postman är en samarbetsplattform för API-utveckling som gör att du kan konfigurera miljöer med förinställda variabler, dela API-samlingar, effektivisera CRUD-begäranden och mycket annat. De flesta Experience Platform API-tjänster har Postman-samlingar som kan användas för att göra API-anrop.

Om du vill veta mer om Postman, t.ex. om hur du konfigurerar en miljö, en lista över tillgängliga samlingar och hur du importerar samlingar kan du gå till Experience Platform Postman-dokumentationen.

Läser exempel-API-anrop sample-api

Format för förfrågningar varierar beroende på vilket Experience Platform API som används. Det bästa sättet att lära sig att strukturera API-anrop är att följa med exemplen i dokumentationen för den Experience Platform-tjänst du använder.

Dokumentationen för Experience Platform visar exempel på API-anrop på två olika sätt. Först presenteras anropet i dess API-format, en mallrepresentation som endast visar åtgärden (GET, POST, PUT, PATCH, DELETE) och den slutpunkt som används (till exempel /global/classes). Vissa mallar visar också var variablerna finns för att illustrera hur ett anrop ska formuleras, till exempel GET /{VARIABLE}/classes/{ANOTHER_VARIABLE}.

Anropen visas sedan som cURL-kommandon i en Request som innehåller nödvändiga rubriker och fullständig "base path" som behövs för att interagera med API:t. Basbanan ska vara förpended för alla slutpunkter. Den tidigare /global/classes-slutpunkten blir till exempel https://platform.adobe.io/data/foundation/schemaregistry/global/classes. Du kommer att se API-formatet/begäranmönstret i hela dokumentationen och förväntas använda den fullständiga sökvägen som visas i exempelbegäran när du anropar Experience Platform API:er.

Exempel på API-begäran

Följande är ett exempel på en API-begäran som visar vilket format du kommer att stöta på i dokumentationen.

API-format

API-formatet visar åtgärden (GET) och slutpunkten som används. Variabler indikeras med klammerparenteser (i det här fallet {CONTAINER_ID}).

GET /{CONTAINER_ID}/classes

Begäran

I den här exempelbegäran får variablerna från API-formatet faktiska värden i sökvägen för begäran. Dessutom visas alla obligatoriska rubriker som antingen exempelvärden för rubriker eller variabler där känslig information (t.ex. säkerhetstoken och åtkomst-ID) ska inkluderas.

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

Svar

Svaret visar vad du förväntar dig efter ett lyckat anrop till API:t, baserat på den begäran som skickades. Ibland kortas svaret av för blanksteg, vilket innebär att du kan se mer information eller mer information än den som visas i exemplet.

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

Felmeddelanden

Experience Platform felsökningsguide innehåller en lista med fel som kan uppstå när du använder någon av Experience Platform-tjänsterna.

Felsökningsguider för enskilda Experience Platform-tjänster finns i tjänstens felsökningskatalog.

Mer information om specifika slutpunkter i Experience Platform API:er, inklusive obligatoriska rubriker och begärandetexter, finns i API-guiderna för Experience Platform.

Experience Platform API-guider api-guides

Mer information om specifika slutpunkter och åtgärder som är tillgängliga för respektive tjänst finns i API-referensdokumentationen på Adobe I/O.

Nästa steg

I det här dokumentet introducerades nödvändiga rubriker, tillgängliga guider och ett exempel på API-anrop. Nu när du har de rubrikvärden som krävs för att göra API-anrop på Adobe Experience Platform väljer du en API-slutpunkt som du vill utforska i tabellen Experience Platform API-guider.

Svar på vanliga frågor finns i Experience Platform felsökningsguide.

Om du vill konfigurera en Postman-miljö och utforska de tillgängliga Postman-samlingarna kan du läsa Experience Platform Postman-handboken.