[Ultieme]{class="badge positive"}

HTTP API-verbinding

Overzicht overview

IMPORTANT
Deze bestemming is alleen beschikbaar voor Adobe Real-time Customer Data Platform Ultimate klanten.

De HTTP API-bestemming is een Adobe Experience Platform streamingbestemming waarmee u profielgegevens naar externe HTTP-eindpunten kunt verzenden.

Als u profielgegevens naar HTTP-eindpunten wilt verzenden, moet u eerst verbinden met de bestemming in Adobe Experience Platform.

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.

Oorsprong publiek
Ondersteund
Beschrijving
Segmentation Service
Door het Experience Platform gegenereerde soorten publiek Segmenteringsservice.
Aangepaste uploads
Soorten publiek geïmporteerd in Experience Platform van CSV-bestanden.

Type en frequentie exporteren export-type-frequency

Raadpleeg de onderstaande tabel voor informatie over het exporttype en de exportfrequentie van de bestemming.

Item
Type
Notities
Exporttype
Profile-based
U exporteert alle leden van een segment samen met de gewenste schemavelden (bijvoorbeeld: e-mailadres, telefoonnummer, achternaam), zoals u hebt gekozen in het toewijzingsscherm van het dialoogvenster doelactiveringsworkflow.
Exportfrequentie
Streaming
Streaming doelen zijn "altijd aan" API-verbindingen. Zodra een profiel in Experience Platform wordt bijgewerkt dat op publieksevaluatie wordt gebaseerd, verzendt de schakelaar de update stroomafwaarts naar het bestemmingsplatform. Meer informatie over streaming doelen.

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. Zie de geëxporteerde gegevens voor een voorbeeld van het Experience Platform uitvoerschema.
  • Uw eindpunt van HTTP moet kopballen steunen.
TIP
U kunt ook Adobe Experience Platform Destination SDK aan opstelling een integratie en verzendt de profielgegevens van het Experience Platform naar een eindpunt van HTTP.

mTLS-protocolondersteuning en -certificaat mtls-protocol-support

U kunt Mutual Transport Layer Security (mTLS) voor verbeterde beveiliging in uitgaande verbindingen met uw HTTP API-doelverbindingen.

mTLS is een van begin tot eind 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 wilt gebruiken mTLS with HTTP API doelen, het serveradres dat u in de bestemmingsdetails pagina moet TLS protocollen uitgeschakeld en alleen mTLS ingeschakeld. Als de TLS 1.2 protocol wordt nog toegelaten op het eindpunt, wordt geen certificaat verzonden voor de cliëntauthentificatie. Dit betekent dat mTLS met uw HTTP API doel, moet uw "ontvangende"servereindpunt een zijn mTLS- slechts toegelaten verbindingspunt.

Certificaat downloaden certificate

Als u de Common Name (CN) en Subject Alternative Names (SAN) voor aanvullende validatie door derden kunt u het onderstaande certificaat downloaden:

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. Zie IP adres lijst van gewenste personen voor het stromen bestemmingen voor 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-clientreferenties verificatie met het lichaamsformulier, met client ID, client secret, en grant type in de hoofdtekst van de HTTP-aanvraag, zoals in het onderstaande voorbeeld wordt getoond.
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>'
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

IMPORTANT
Om met de bestemming te verbinden, hebt u nodig View Destinations en Manage Destinations toegangsbeheermachtigingen. Lees de toegangsbeheeroverzicht of neem contact op met de productbeheerder om de vereiste machtigingen te verkrijgen.

Als u verbinding wilt maken met dit doel, voert u de stappen uit die in het dialoogvenster zelfstudie over doelconfiguratie. Wanneer u verbinding maakt met dit doel, moet u de volgende informatie opgeven:

Verificatiegegevens authentication-information

Toekennerverificatie bearer-token-authentication

Als u Bearer token autorisatietype voor verbinding met het HTTP-eindpunt, voer de onderstaande velden in en selecteer Connect to destination:

Afbeelding van het UI-scherm waarin u verbinding kunt maken met de HTTP API-bestemming met behulp van toventokenverificatie.

  • Bearer token: voeg het token voor toonder in om te verifiëren bij uw HTTP-locatie.

Geen verificatie no-authentication

Als u None authentificatietype om met uw eindpunt van HTTP te verbinden:

Afbeelding van het UI-scherm waar u verbinding kunt maken met de HTTP API-bestemming, zonder verificatie.

Wanneer u deze verificatie opent, hoeft u alleen Connect to destination en de verbinding aan uw eindpunt wordt gevestigd.

OAuth 2 Password authentication oauth-2-password-authentication

Als u OAuth 2 Password autorisatietype voor verbinding met het HTTP-eindpunt, voer de onderstaande velden in en selecteer Connect to destination:

Afbeelding van het UI-scherm waarin u verbinding kunt maken met de HTTP API-bestemming met OAuth 2 met wachtwoordverificatie.

  • Access Token URL: De URL aan uw zijde die toegangstokens uitgeeft en, naar keuze, tokens vernieuwt.
  • Client ID: De client ID dat uw systeem aan Adobe Experience Platform toewijst.
  • Client Secret: De client secret dat uw systeem aan Adobe Experience Platform toewijst.
  • Username: De gebruikersnaam om toegang te krijgen tot uw 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 OAuth 2 Client Credentials autorisatietype voor verbinding met het HTTP-eindpunt, voer de onderstaande velden in en selecteer Connect to destination:

Afbeelding van het UI-scherm waarin u verbinding kunt maken met de HTTP API-bestemming, met OAuth 2 met verificatie van clientreferenties.

  • Access Token URL: De URL aan uw zijde die toegangstokens uitgeeft en, naar keuze, tokens vernieuwt.

  • Client ID: De client ID dat uw systeem aan Adobe Experience Platform toewijst.

  • Client Secret: De client secret dat uw systeem aan Adobe Experience Platform toewijst.

  • Client Credentials Type: Selecteer het type van OAuth2 de subsidie van de Kredieten van de Cliënt die door uw eindpunt wordt gesteund:

    • Body Form Encoded: In dit geval wordt de client ID en client secret worden opgenomen in de inhoud van het verzoek verzonden naar uw bestemming. Zie voor een voorbeeld de Ondersteunde verificatietypen sectie.
    • Basic Authorization: In dit geval wordt de client ID en client secret worden opgenomen in een Authorization header nadat base64 gecodeerd en verzonden naar uw bestemming is. Zie voor een voorbeeld de Ondersteunde verificatietypen sectie.

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.

Afbeelding van het UI-scherm waarin de voltooide velden voor de HTTP-doeldetails worden weergegeven.

  • 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, na dit formaat: 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 vraagparameters op u als volgt gebruikt: parameter1=value&parameter2=value.
  • Include Segment Names: Schakel deze optie in 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 gegevensexport waarbij deze optie is geselecteerd, raadpleegt u de Geëxporteerde gegevens 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 aan de bestemming is toegewezen. Voor een voorbeeld van een gegevensexport waarbij deze optie is geselecteerd, raadpleegt u de Geëxporteerde gegevens 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. Zie de handleiding voor meer informatie over waarschuwingen abonneren op bestemmingen die het alarm gebruiken UI.

Wanneer u klaar bent met het opgeven van details voor uw doelverbinding, selecteert u Next.

Soorten publiek naar dit doel activeren activate

IMPORTANT

Zie De publieksgegevens van de activering aan het stromen profiel de uitvoerbestemmingen voor instructies voor het activeren van het publiek naar deze bestemming.

Doelkenmerken attributes

In de Select attributes stap, raadt de Adobe u aan een unieke id te selecteren in uw samenvoegingsschema. 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 is bepaald door een wijziging in het dialoogvenster identiteitsbewijs. 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 de gegevens die voor een bepaald profiel worden geëxporteerd, is het belangrijk dat u de twee verschillende concepten van wat een gegevensexport naar uw HTTP API-bestemming bepaalt en welke gegevens in de uitvoer worden opgenomen.

Wat bepaalt de doelexport
Wat is inbegrepen in de doelexport
  • 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 tot realized of van realized tot exiting) of toegewezen kenmerken worden bijgewerkt, wordt een doelexport 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.
  • De segmentMembership bevat het publiek dat is toegewezen in de activeringsgegevensstroom, waarvoor de status van het profiel is gewijzigd na een afsluitgebeurtenis voor kwalificatie of het publiek. Andere niet-toegewezen soorten publiek waarvoor het profiel waarvoor is gekwalificeerd, deel kan uitmaken van de doelexport, als deze soorten publiek tot hetzelfde behoren samenvoegingsbeleid als het publiek is toegewezen in de activeringsgegevensstroom.
  • Alle identiteiten in de 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 voorbeeld van een HTTP API doelgegevensstroom.

Een profiel dat naar de bestemming wordt geëxporteerd, kan worden bepaald door een profiel dat in aanmerking komt voor of dat een van de drie toegewezen segmenten. Bij de gegevensexport moet u echter in de segmentMembership object (zie Geëxporteerde gegevens in de onderstaande sectie), kunnen andere niet-toegewezen doelgroepen worden weergegeven als dat specifieke profiel lid van die doelgroepen is en als deze hetzelfde samenvoegingsbeleid delen als het publiek dat de exportactie heeft geactiveerd. Als een profiel voor het Klant met DeLorean Auto's segment, maar ook lid van "Terug naar de toekomst" film en Favorieten voor science fiction segmenten, dan zullen deze andere twee soorten publiek ook in de segmentMembership -object van de gegevensexport, ook al worden deze niet toegewezen in de gegevensstroom, als deze hetzelfde samenvoegbeleid delen met de Klant met DeLorean Auto's segment.

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 in aanmerking komen voor het publiek voor het publiek dat aan de bestemming is toegevoegd, wordt binnen ongeveer een uur naar de bestemming geëxporteerd.

Geëxporteerde gegevens exported-data

Uw geëxporteerde Experience Platform gegevensterreinen in uw HTTP doel in JSON-indeling. 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 het verbinden van Include Segment Names en Include Segment Timestamps opties:

In het onderstaande voorbeeld voor het exporteren van gegevens worden publieksnamen opgenomen in het deelvenster segmentMembership sectie
code language-json
"segmentMembership": {
        "ups": {
          "5b998cb9-9488-4ec3-8d95-fa8338ced490": {
            "lastQualificationTime": "2019-04-15T02:41:50+0000",
            "status": "realized",
            "createdAt": 1648553325000,
            "updatedAt": 1648553330000,
            "mappingCreatedAt": 1649856570000,
            "mappingUpdatedAt": 1649856570000,
            "name": "First name equals John"
          }
        }
      }
Het onderstaande voorbeeld voor het exporteren van gegevens bevat tijdstempels voor het publiek in het dialoogvenster segmentMembership sectie
code language-json
"segmentMembership": {
        "ups": {
          "5b998cb9-9488-4ec3-8d95-fa8338ced490": {
            "lastQualificationTime": "2019-04-15T02:41:50+0000",
            "status": "realized",
            "createdAt": 1648553325000,
            "updatedAt": 1648553330000,
            "mappingCreatedAt": 1649856570000,
            "mappingUpdatedAt": 1649856570000,
          }
        }
      }

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.

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6