Identity Service API-handleiding
Adobe Experience Platform Identity Service beheert de cross-device, cross-channel en bijna real-time identificatie van uw klanten in een zogenaamde identiteitsgrafiek in Adobe Experience Platform.
Aan de slag
Deze handleiding vereist een goed begrip van de volgende onderdelen van Adobe Experience Platform:
- Identity Service: Oplost de fundamentele uitdaging die door de fragmentatie van gegevens van het klantenprofiel wordt gesteld. Het doet dit door identiteiten over apparaten en systemen te overbruggen waar de klanten met uw merk in wisselwerking staan.
- Real-Time Customer Profile: Biedt een uniform, consumentenprofiel in real-time op basis van geaggregeerde gegevens van meerdere bronnen.
- Experience Data Model (XDM): Het gestandaardiseerde kader waarbinnen Platform organiseert de gegevens van de klantenervaring.
De volgende secties verstrekken extra informatie die u zult moeten kennen of hebben aan met succes vraag aan Identity Service API.
API-voorbeeldaanroepen lezen
Deze gids verstrekt voorbeeld API vraag om aan te tonen hoe te om uw verzoeken te formatteren. Dit zijn paden, vereiste kopteksten en correct opgemaakte ladingen voor aanvragen. Voorbeeld-JSON die wordt geretourneerd in API-reacties, wordt ook verschaft. Voor informatie over de conventies die worden gebruikt in documentatie voor voorbeeld-API-aanroepen raadpleegt u de sectie over voorbeeld-API-aanroepen lezen in de Experience Platform gids voor probleemoplossing.
Waarden verzamelen voor vereiste koppen
Om vraag te maken aan Platform API's, moet u eerst de verificatiezelfstudie. Het voltooien van de zelfstudie over verificatie biedt de waarden voor elk van de vereiste kopteksten in alle Experience Platform API-aanroepen, zoals hieronder wordt getoond:
- Toestemming: houder
{ACCESS_TOKEN} - x-api-key:
{API_KEY} - x-gw-ims-org-id:
{ORG_ID}
Alle bronnen in Experience Platform zijn geïsoleerd naar specifieke virtuele sandboxen. Alle verzoeken aan Platform API's vereisen een header die de naam aangeeft van de sandbox waarin de bewerking plaatsvindt:
- x-sandbox-name:
{SANDBOX_NAME}
Alle verzoeken die een nuttige lading (POST, PUT, PATCH) bevatten vereisen een extra kopbal:
- Inhoudstype: application/json
Regionaal verpletteren
De Identity Service API gebruikt regio-specifieke eindpunten die de opname van een {REGION} als onderdeel van het aanvraagpad. Tijdens de levering van uw organisatie, wordt een gebied bepaald en opgeslagen binnen uw organisatieprofiel. Het gebruiken van het correcte gebied met elk eindpunt zorgt ervoor dat alle die verzoeken gebruikend worden gemaakt Identity Service API worden naar het juiste gebied gerouteerd.
Er zijn momenteel twee gebieden die worden ondersteund door Identity Service API's: VA7 en NLD2.
In de onderstaande tabel worden voorbeeldpaden met behulp van gebieden weergegeven:
Als u het gebied niet kunt vinden binnen uw organisatieprofiel, gelieve uw systeembeheerder voor steun te contacteren.
Met de Identity Service API
De parameters van de identiteit die in deze diensten worden gebruikt kunnen op één van twee manieren worden uitgedrukt; samenstelling of XID.
Samengestelde identiteiten zijn constructies die zowel de ID-waarde als de naamruimte omvatten. Wanneer u samengestelde identiteiten gebruikt, kan de naamruimte worden opgegeven door een van de volgende namen (namespace.code) of ID (namespace.id).
Wanneer een identiteit wordt voortgeduurd, Identity Service Hiermee genereert en wijst u een id toe aan die identiteit, de native id of XID. Alle variaties van de API's voor clusterbeheer en toewijzing ondersteunen zowel samengestelde identiteiten als XID in hun aanvragen en antwoorden. Een van de parameters is vereist - xid of combinatie van [ns of nsid] en id om deze API's te gebruiken.
Om de lading in reacties te beperken, passen APIs hun reacties aan het type van gebruikte identiteitsconstructie aan. Als u XID doorgeeft aan uw reacties, hebben XID's als u samengestelde identiteiten doorgeeft, volgt de reactie de structuur die in de aanvraag wordt gebruikt.
In de voorbeelden in dit document wordt niet ingegaan op de volledige functionaliteit van de Identity Service API. Voor de volledige API raadpleegt u de Referentie voor Tagger-API.
Volgende stappen
Nu u de vereiste geloofsbrieven hebt verzameld, kunt u nu de rest gids van de ontwikkelaar blijven lezen. Elke sectie verstrekt belangrijke informatie betreffende hun eindpunten en toon voorbeeld API vraag voor het uitvoeren van verrichtingen CRUD aan. Elke vraag omvat het algemene API formaat, een steekproefverzoek die vereiste kopballen en behoorlijk geformatteerde lading toont, en een steekproefreactie voor een succesvolle vraag.