[Ultieme]{class="badge positive"}
HTTP API-verbinding
Overzicht overview
De HTTP API-bestemming is een Adobe Experience Platform streamingbestemming die u helpt profielgegevens naar HTTP-eindpunten van derden te verzenden.
Om profielgegevens naar eindpunten van HTTP te verzenden, moet u eerst met de bestemmingin Adobe Experience Platform verbinden.
Gebruiksscenario’s use-cases
Met de HTTP API-bestemming kunt u XDM-profielgegevens en -publiek exporteren naar algemene HTTP-eindpunten. Daar kunt u uw eigen analyses uitvoeren of andere bewerkingen uitvoeren die u nodig hebt voor profielgegevens die uit het Experience Platform zijn geëxporteerd.
De eindpunten van HTTP kunnen of de systemen van klanten of derdeoplossingen zijn.
Ondersteunde doelgroepen supported-audiences
In deze sectie wordt beschreven welke soorten publiek u naar dit doel kunt exporteren.
Type en frequentie exporteren export-type-frequency
Raadpleeg de onderstaande tabel voor informatie over het exporttype en de exportfrequentie van de bestemming.
Vereisten prerequisites
Als u de HTTP API-bestemming wilt gebruiken om gegevens uit Experience Platform te exporteren, moet u aan de volgende voorwaarden voldoen:
- U moet een eindpunt van HTTP hebben dat REST API steunt.
- Uw eindpunt van HTTP moet het het profielschema van het Experience Platform steunen. Transformatie naar een extern payload-schema wordt niet ondersteund in de HTTP API-bestemming. Verwijs naar de uitgevoerde gegevenssectie voor een voorbeeld van het schema van de Experience Platform output.
- Uw eindpunt van HTTP moet kopballen steunen.
mTLS-protocolondersteuning en -certificaat mtls-protocol-support
U kunt Mutual Transport Layer Security (mTLS) gebruiken om verbeterde veiligheid in uitgaande verbindingen aan uw HTTP API bestemmingsverbindingen te verzekeren.
mTLS is een end-to-end veiligheidsmethode voor wederzijdse authentificatie die ervoor zorgt dat beide partijen die informatie delen wie zij beweren te zijn alvorens de gegevens worden gedeeld. mTLS bevat een extra stap in vergelijking met TLS , waarin de server ook om het certificaat van de client vraagt en dit aan het einde verifieert.
Als u mTLS met HTTP API bestemmingen wilt gebruiken, moet het serveradres u in de bestemmingsdetailspagina zetten TLS gehandicapte protocollen hebben en slechts mTLS toegelaten. Als het TLS 1.2 protocol nog op het eindpunt wordt toegelaten, wordt geen certificaat verzonden voor de cliëntauthentificatie. Dit betekent dat om mTLS met uw HTTP API bestemming te gebruiken, uw "ontvangende"servereindpunt een mTLS - slechts toegelaten verbindingspunt moet zijn.
Certificaat downloaden certificate
Als u Common Name (CN) en Subject Alternative Names (SAN) wilt controleren voor extra validatie door derden, kunt u het volgende certificaat downloaden:
U kunt openbare certificaten ook veilig terugwinnen door een verzoek van de GET tot het eindpunt MTLS te richten. Zie de openbare documentatie van het certificaateindpuntvoor meer informatie.
IP adres lijst van gewenste personen ip-address-allowlist
Om klanten' veiligheid en nalevingsvereisten te ontmoeten, verstrekt het Experience Platform een lijst van statische IPs die u voor de bestemming van HTTP kunt lijsten van gewenste personen API. Verwijs naar IP adreslijst van gewenste personen voor het stromen bestemmingenvoor de volledige lijst van IPs aan lijst van gewenste personen.
Ondersteunde verificatietypen supported-authentication-types
De HTTP API bestemming steunt verscheidene authentificatietypen aan uw eindpunt van HTTP:
- HTTP-eindpunt zonder verificatie;
- Toekenning aan toonder;
- OAuth 2.0 cliëntgeloofsbrievenauthentificatie met de lichaamvorm, met client ID, client secret, en grant type in het lichaam van het HTTP- verzoek, zoals aangetoond in het voorbeeld hieronder.
curl --location --request POST '<YOUR_API_ENDPOINT>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=<CLIENT_ID>' \
--data-urlencode 'client_secret=<CLIENT_SECRET>'
- OAuth 2.0 cliëntgeloofsbrievenmet basisvergunning, met een vergunningskopbal die URL-Gecodeerde client ID en client secret bevat.
curl --location --request POST 'https://some-api.com/token' \
--header 'Authorization: Basic base64(clientId:clientSecret)' \
--header 'Content-type: application/x-www-form-urlencoded; charset=UTF-8' \
--data-urlencode 'grant_type=client_credentials'
Verbinden met de bestemming connect-destination
Om met deze bestemming te verbinden, volg de stappen die in het leerprogramma van de bestemmingsconfiguratieworden beschreven. Wanneer u verbinding maakt met dit doel, moet u de volgende informatie opgeven:
Verificatiegegevens authentication-information
Toekennerverificatie bearer-token-authentication
Als u het verificatietype Bearer token selecteert om verbinding te maken met het HTTP-eindpunt, voert u de onderstaande velden in en selecteert u Connect to destination :
- Bearer token: voeg het token voor toonder in om te verifiëren bij uw HTTP-locatie.
Geen verificatie no-authentication
Als u het verificatietype None selecteert om verbinding te maken met het HTTP-eindpunt:
Wanneer u deze verificatie opent, hoeft u alleen Connect to destination te selecteren en de verbinding met het eindpunt tot stand te brengen.
OAuth 2 Password authentication oauth-2-password-authentication
Als u het verificatietype OAuth 2 Password selecteert om verbinding te maken met het HTTP-eindpunt, voert u de onderstaande velden in en selecteert u Connect to destination :
- Access Token URL: De URL aan uw zijde die toegangstokens uitgeeft en, naar keuze, tokens vernieuwt.
- Client ID: De client ID die uw systeem toewijst aan Adobe Experience Platform.
- Client Secret: De client secret die uw systeem toewijst aan Adobe Experience Platform.
- Username: De gebruikersnaam die toegang geeft tot het HTTP-eindpunt.
- Password: Het wachtwoord om tot uw eindpunt van HTTP toegang te hebben.
OAuth 2 Client Credentials-verificatie oauth-2-client-credentials-authentication
Als u het verificatietype OAuth 2 Client Credentials selecteert om verbinding te maken met het HTTP-eindpunt, voert u de onderstaande velden in en selecteert u Connect to destination :
-
Access Token URL: De URL aan uw zijde die toegangstokens uitgeeft en, naar keuze, tokens vernieuwt.
-
Client ID: De client ID die uw systeem toewijst aan Adobe Experience Platform.
-
Client Secret: De client secret die uw systeem toewijst aan Adobe Experience Platform.
-
Client Credentials Type: Selecteer het type OAuth2 Client Credentials gift die door uw eindpunt wordt gesteund:
- Body Form Encoded: In dit geval, zijn client ID en client secret inbegrepen in het lichaam van het verzoek dat naar uw bestemming wordt verzonden. Bij een voorbeeld, zie de Ondersteunde authentificatietypensectie.
- Basic Authorization: In dit geval, zijn client ID en client secret inbegrepen in een
Authorization
kopbal na het worden base64 gecodeerd en verzonden naar uw bestemming. Bij een voorbeeld, zie de Ondersteunde authentificatietypensectie.
Doelgegevens invullen destination-details
Als u details voor de bestemming wilt configureren, vult u de vereiste en optionele velden hieronder in. Een sterretje naast een veld in de gebruikersinterface geeft aan dat het veld verplicht is.
- Name: voer een naam in waarmee u dit doel in de toekomst wilt herkennen.
- Description: voer een beschrijving in die u helpt deze bestemming in de toekomst te identificeren.
- Headers: ga om het even welke douanekopballen in die u in de bestemmingsvraag wilt worden omvat, die dit formaat volgen:
header1:value1,header2:value2,...headerN:valueN
. - HTTP Endpoint: De URL van het HTTP-eindpunt waarnaar u de profielgegevens wilt verzenden.
- Query parameters: U kunt optioneel queryparameters toevoegen aan de URL van het HTTP-eindpunt. Maak de queryparameters die u op deze manier gebruikt op:
parameter1=value¶meter2=value
. - Include Segment Names: in-/uitschakelen als u wilt dat bij het exporteren van de gegevens de namen worden opgenomen van het publiek dat u exporteert. Voor een voorbeeld van een gegevens die met deze geselecteerde optie uitvoeren, verwijs naar de Uitgevoerde gegevenssectie verder hieronder.
- Include Segment Timestamps: Schakel deze optie in als u wilt dat bij het exporteren van de gegevens de UNIX-tijdstempel wordt gebruikt wanneer het publiek is gemaakt en bijgewerkt, en ook de UNIX-tijdstempel wanneer het publiek voor activering is toegewezen aan het doel. Voor een voorbeeld van een gegevens die met deze geselecteerde optie uitvoeren, verwijs naar de Uitgevoerde gegevenssectie verder hieronder.
Waarschuwingen inschakelen enable-alerts
U kunt alarm toelaten om berichten over de status van dataflow aan uw bestemming te ontvangen. Selecteer een waarschuwing in de lijst om u te abonneren op meldingen over de status van uw gegevensstroom. Voor meer informatie over alarm, zie de gids bij het intekenen aan bestemmingsalarm gebruikend UI.
Wanneer u klaar bent met het opgeven van details voor uw doelverbinding, selecteert u Next .
Soorten publiek naar dit doel activeren activate
- Om gegevens te activeren, hebt u View Destinations, Activate Destinations, View Profiles, en View Segments toegangsbeheertoestemmingennodig. Lees het overzicht van de toegangscontroleof contacteer uw productbeheerder om de vereiste toestemmingen te verkrijgen.
- de beleidsevaluatie van de Goedkeuringwordt momenteel niet gesteund in de uitvoer naar de bestemming van HTTP API. Meer informatie.
Zie publieksgegevens aan het stromen van profieluitvoer bestemmingenvoor instructies op het activeren van publiek aan deze bestemming activeren.
Doelkenmerken attributes
In de Select attributes stap, adviseert de Adobe dat u een uniek herkenningsteken van uw verenigingsschemaselecteert. Selecteer de unieke id en andere XDM-velden die u naar het doel wilt exporteren.
Exportgedrag profiel profile-export-behavior
Experience Platform optimaliseert het gedrag van de profieluitvoer naar uw bestemming van HTTP API, om gegevens naar uw API eindpunt slechts uit te voeren wanneer de relevante updates aan een profiel na publiekskwalificatie of andere significante gebeurtenissen zijn voorgekomen. In de volgende situaties worden profielen naar uw doel geëxporteerd:
- De profielupdate werd bepaald door een wijziging in het publiekslidmaatschap voor ten minste een van de doelgroepen. Het profiel is bijvoorbeeld gekwalificeerd voor een van de soorten publiek die aan de bestemming zijn toegewezen of heeft een van de soorten publiek afgesloten die aan de bestemming zijn toegewezen.
- De profielupdate werd bepaald door een verandering in de identiteitskaart. Een profiel dat bijvoorbeeld al was gekwalificeerd voor een van de soorten publiek dat aan de bestemming is toegewezen, is toegevoegd aan een nieuwe identiteit in het kenmerk Naamplaatje.
- De profielupdate is bepaald door een wijziging in kenmerken voor ten minste een van de kenmerken die aan de bestemming zijn toegewezen. Een van de kenmerken die in de toewijzingsstap aan het doel is toegewezen, wordt bijvoorbeeld aan een profiel toegevoegd.
In alle hierboven beschreven gevallen worden alleen de profielen waarin relevante updates zijn opgetreden, naar uw bestemming geëxporteerd. Bijvoorbeeld, als een publiek dat aan de bestemmingsstroom in kaart wordt gebracht honderd leden heeft, en vijf nieuwe profielen voor het segment kwalificeren, is de uitvoer naar uw bestemming incrementeel en omvat slechts de vijf nieuwe profielen.
Alle toegewezen kenmerken worden geëxporteerd voor een profiel, ongeacht de locatie van de wijzigingen. In het voorbeeld hierboven worden alle toegewezen kenmerken voor deze vijf nieuwe profielen geëxporteerd, zelfs als de kenmerken zelf niet zijn gewijzigd.
Wat bepaalt een gegevensexport en wat wordt opgenomen in de export? what-determines-export-what-is-included
Met betrekking tot het gegeven dat voor een bepaald profiel wordt uitgevoerd, is het belangrijk om de twee verschillende concepten te begrijpen wat een gegevensuitvoer aan uw bestemming van HTTP API en bepaalt welke gegevens in de uitvoer inbegrepen zijn.
- Toegewezen kenmerken en doelgroepen fungeren als actiepunt voor het exporteren van een bestemming. Dit betekent dat als een toegewezen publiek de status wijzigt (van
null
inrealized
of vanrealized
inexiting
) of dat toegewezen kenmerken worden bijgewerkt, een doelexport wordt uitgeschakeld. - Omdat identiteiten momenteel niet aan de bestemmingen van HTTP kunnen worden in kaart gebracht API, bepalen de veranderingen in om het even welke identiteit op een bepaald profiel ook bestemmingsuitvoer.
- Een wijziging voor een kenmerk wordt gedefinieerd als een update voor het kenmerk, ongeacht of het dezelfde waarde heeft of niet. Dit houdt in dat een overschrijven van een kenmerk als een wijziging wordt beschouwd, zelfs als de waarde zelf niet is gewijzigd.
- Het
segmentMembership
-object bevat het publiek dat is toegewezen in de activeringsgegevensstroom, waarvoor de status van het profiel is gewijzigd na een afsluitgebeurtenis voor kwalificatie of publiek. Merk op dat andere niet in kaart gebrachte publiek waarvoor het profiel dat voor wordt gekwalificeerd deel van de bestemmingsuitvoer kan uitmaken, als deze doelgroepen tot het zelfde fusiebeleidzoals het publiek behoren dat in activeringsdataflow in kaart wordt gebracht. - Alle identiteiten in het
identityMap
-object worden ook opgenomen (Experience Platform ondersteunt momenteel geen identiteitstoewijzing in de HTTP API-bestemming). - Alleen de toegewezen kenmerken worden opgenomen in de doelexport.
Bijvoorbeeld, overweeg dit dataflow aan een bestemming van HTTP waar drie publiek in dataflow wordt geselecteerd, en vier attributen worden in kaart gebracht aan de bestemming.
Een profieluitvoer naar de bestemming kan door een profiel worden bepaald dat voor of het weggaan van één van drie in kaart gebrachte segmenten in aanmerking komt. Nochtans, in de gegevensuitvoer, in het segmentMembership
voorwerp (zie Uitgevoerde Gegevenssectie hieronder), zouden andere niet in kaart gebrachte toehoorders kunnen verschijnen, als dat bepaalde profiel een lid van hen is en als deze het zelfde fusiebeleid zoals het publiek delen dat de uitvoer teweegbracht. Als een profiel voor de Klant met DeLorean Cars segment maar ook een lid van het Gecontroleerde "Terug naar de Toekomstige" film en de de fictiefondsen van de Wetenschap segmenten kwalificeert, dan zullen deze andere twee publiek ook in het segmentMembership
voorwerp van de gegevensuitvoer aanwezig zijn, alhoewel deze niet in dataflow worden in kaart gebracht, als deze zelfde samenvoegingsbeleid delen met de Klant met het segment van de AutoAuto's van DeLorean.
Vanuit het oogpunt van profielkenmerken bepalen wijzigingen in de vier bovenstaande kenmerken de doelexport en zijn alle vier toegewezen kenmerken in het profiel aanwezig in de gegevensexport.
Back-up van historische gegevens historical-data-backfill
Wanneer u een nieuw publiek aan een bestaande bestemming toevoegt, of wanneer u een nieuw doel en kaartpubliek aan het creeert, voert het Experience Platform historische gegevens van de publiekskwalificatie naar de bestemming uit. Profielen die voor het publiek kwalificeerden alvorens het publiek aan de bestemming werd toegevoegd worden uitgevoerd naar de bestemming binnen ongeveer één uur.
Geëxporteerde gegevens exported-data
De geëxporteerde Experience Platform gegevens worden in JSON-indeling in uw HTTP -doel geplaatst. Bijvoorbeeld, bevat de hieronder uitvoer een profiel dat voor een bepaald segment heeft gekwalificeerd, een lid van andere twee segmenten is, en een ander segment verliet. Het exporteren bevat ook de voornaam, achternaam, geboortedatum en het persoonlijke e-mailadres van het profielkenmerk. De identiteiten voor dit profiel zijn ECID en e-mail.
{
"person": {
"birthDate": "YYYY-MM-DD",
"name": {
"firstName": "John",
"lastName": "Doe"
}
},
"personalEmail": {
"address": "john.doe@acme.com"
},
"segmentMembership": {
"ups":{
"7841ba61-23c1-4bb3-a495-00d3g5fe1e93":{
"lastQualificationTime":"2022-01-11T21:24:39Z",
"status":"exited"
},
"59bd2fkd-3c48-4b18-bf56-4f5c5e6967ae":{
"lastQualificationTime":"2022-01-02T23:37:33Z",
"status":"realized"
},
"947c1c46-008d-40b0-92ec-3af86eaf41c1":{
"lastQualificationTime":"2021-08-25T23:37:33Z",
"status":"realized"
},
"5114d758-ce71-43ba-b53e-e2a91d67b67f":{
"lastQualificationTime":"2022-01-11T23:37:33Z",
"status":"realized"
}
}
},
"identityMap": {
"ecid": [
{
"id": "14575006536349286404619648085736425115"
},
{
"id": "66478888669296734530114754794777368480"
}
],
"email_lc_sha256": [
{
"id": "655332b5fa2aea4498bf7a290cff017cb4"
},
{
"id": "66baf76ef9de8b42df8903f00e0e3dc0b7"
}
]
}
}
Hieronder vindt u meer voorbeelden van geëxporteerde gegevens, afhankelijk van de UI-instellingen die u hebt geselecteerd in de doelstroom voor verbinden voor de opties Include Segment Names en Include Segment Timestamps :
segmentMembership
code language-json |
---|
|
segmentMembership
code language-json |
---|
|
Beperkingen en beleid opnieuw proberen limits-retry-policy
In 95 percent van de tijd, probeert het Experience Platform om een productietolerantie van minder dan 10 minuten voor met succes verzonden berichten met een tarief van minder dan 10.000 verzoeken per seconde voor elke dataflow aan een bestemming van HTTP aan te bieden.
In het geval van ontbroken verzoeken aan uw bestemming van HTTP API, slaat het Experience Platform de ontbroken verzoeken op en probeert tweemaal om de verzoeken naar uw eindpunt te verzenden.