API-guide för Identity Service

Adobe Experience Platform Identity Service hanterar identifieringen av dina kunder över olika enheter, i flera kanaler och i realtid i det som kallas identitetsdiagram inom Adobe Experience Platform.

Komma igång

Handboken kräver en fungerande förståelse av följande komponenter i Adobe Experience Platform:

I följande avsnitt finns ytterligare information som du behöver känna till eller ha till hands för att kunna anropa API:t Identity Service.

Läser exempel-API-anrop

Den här guiden innehåller exempel på API-anrop som visar hur du formaterar dina begäranden. Det kan vara sökvägar, obligatoriska rubriker och korrekt formaterade begärandenyttolaster. Ett exempel på JSON som returneras i API-svar finns också. Information om de konventioner som används i dokumentationen för exempel-API-anrop finns i avsnittet Så här läser du exempel-API-anrop i felsökningsguiden för Experience Platform.

Samla in värden för obligatoriska rubriker

För att kunna anropa Platform API:er måste du först slutföra autentiseringssjälvstudiekursen. När du slutför självstudiekursen för autentisering visas värdena för var och en av de obligatoriska rubrikerna i alla Experience Platform API-anrop, vilket visas nedan:

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

Alla begäranden som innehåller en nyttolast (POST, PUT, PATCH) kräver ytterligare en rubrik:

Regionbaserad routning

API:t Identity Service använder regionspecifika slutpunkter som kräver att {REGION} inkluderas som en del av begäranssökvägen. Under etableringen av organisationen bestäms en region och lagras i din organisationsprofil. Genom att använda rätt region för varje slutpunkt ser du till att alla begäranden som görs med API:t Identity Service dirigeras till rätt region.

Det finns för närvarande två regioner som stöds av Identity Service API VA7 och NLD2.

Tabellen nedan visar exempelsökvägar som använder regioner:

Om du inte kan hitta regionen i din organisationsprofil kontaktar du systemadministratören för att få hjälp.

Använda API:t Identity Service

Identitetsparametrar som används i dessa tjänster kan uttryckas på ett av två sätt: sammansatt eller XID.

Sammansatta identiteter är konstruktioner som innehåller både ID-värdet och namnutrymmet. När du använder sammansatta identiteter kan namnutrymmet anges med antingen namn (namespace.code) eller ID (namespace.id).

När en identitet bevaras genererar och tilldelar Identity Service ett ID till den identiteten, som kallas ursprungligt ID eller XID. Alla variationer av kluster- och mappnings-API:er har stöd för både sammansatta identiteter och XID i sina begäranden och svar. En av parametrarna krävs - xid eller en kombination av [ns eller nsid] och id - för att använda dessa API:er.

För att begränsa nyttolasten i svaren anpassar API:erna sina svar till den typ av identitetskonstruktion som används. Det vill säga, om du skickar XID:n kommer svaren att ha XID:n, och om du skickar sammansatta identiteter kommer svaret att följa den struktur som används i begäran.

Exemplen i det här dokumentet täcker inte den fullständiga funktionen för API:t Identity Service. Fullständigt API finns i API-referens för Swagger.

Nästa steg

Nu när du har samlat in de nödvändiga inloggningsuppgifterna kan du nu fortsätta att läsa resten av utvecklarhandboken. Varje avsnitt innehåller viktig information om deras slutpunkter och visar exempel på API-anrop för att utföra CRUD-åtgärder. Varje anrop innehåller det allmänna API-formatet, en exempelbegäran som visar nödvändiga huvuden och korrekt formaterade nyttolaster samt ett exempelsvar för ett lyckat anrop.