[Ultimate]{class="badge positive"}

HTTP API-verbinding

Overzicht overview

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

Om profielgegevens naar eindpunten van HTTP te verzenden, moet u eerst ​ met de bestemming ​ in Experience Platform verbinden.

Gebruiksscenario's use-cases

Gebruik de HTTP API-bestemming om XDM-profielgegevens en -publiek te exporteren naar algemene HTTP-eindpunten. Daar kunt u uw eigen analyses uitvoeren of andere bewerkingen uitvoeren die u nodig hebt voor profielgegevens die uit 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.

Ondersteund publiek per type publieksgegevens:

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:

mTLS-protocolondersteuning en -certificaat mtls-protocol-support

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

mTLS is een wederzijds authentificatieprotocol dat 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 standaard-TLS, waarin de server ook om het clientcertificaat vraagt en dit verifieert, terwijl de client het servercertificaat verifieert.

mTLS-overwegingen mtls-considerations

De steun mTLS voor HTTP API bestemmingen past slechts op de gegevens toe die eindpunt ontvangen waar de profieluitvoer wordt verzonden (het HTTP Endpoint gebied in ​ bestemmingsdetails ​).

mTLS configureren voor gegevensexport configuring-mtls

Om mTLS met HTTP API bestemmingen te gebruiken, HTTP Endpoint (gegevens die eindpunt ontvangen) u in de ​ bestemmingdetails ​ pagina vormt moet de protocollen van TLS gehandicapt 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 bestemming van HTTP API te gebruiken, uw gegevens die servereindpunt ontvangen een mTLS-slechts toegelaten verbindingspunt moeten zijn.

Certificaatdetails ophalen en inspecteren certificate

Als u certificaatdetails zoals de Gemeenschappelijke Naam (CN) en de Alternatieve Namen van het Onderwerp (San) voor extra derdebevestiging wilt inspecteren, gebruik API om het certificaat terug te winnen en die gebieden uit de reactie te halen.

Zie de ​ openbare documentatie van het certificaateindpunt ​ voor meer informatie.

IP adres lijst van gewenste personen ip-address-allowlist

Experience Platform biedt een lijst met statische IP's die u voor de HTTP API-bestemming kunt lijsten van gewenste personen om aan de beveiligings- en compatibiliteitseisen van klanten te voldoen. Zie {de lijst van gewenste personen van het 0} IP adres 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:

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

Om met deze bestemming te verbinden, volg de stappen die in het ​ leerprogramma van de bestemmingsconfiguratie ​ worden 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 hieronder de informatie in en selecteert u Connect to destination :

Geen verificatie no-authentication

Als u het verificatietype None selecteert om verbinding te maken met het HTTP-eindpunt:

Wanneer u deze verificatieoptie selecteert, 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 hieronder de informatie in en selecteert u Connect to destination :

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 hieronder de informatie in en selecteert u Connect to destination :

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.

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

Zie ​ publieksgegevens aan het stromen van profieluitvoer bestemmingen ​ voor instructies op het activeren van publiek aan deze bestemming activeren.

Doelkenmerken attributes

In de Select attributes stap, adviseert Adobe dat u een uniek herkenningsteken van uw ​ verenigingsschema ​ selecteert. 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 voor het exporteren van profielen naar uw HTTP API-bestemming, zodat alleen gegevens naar uw API-eindpunt worden geëxporteerd wanneer relevante updates naar een profiel zijn opgetreden na de kwalificatie van het publiek of andere belangrijke gebeurtenissen. In de volgende situaties worden profielen naar uw doel geëxporteerd:

In alle hierboven beschreven gevallen worden alleen de profielen waarin relevante updates zijn opgetreden, naar uw bestemming geëxporteerd. Als een publiek dat is toegewezen aan de doelstroom bijvoorbeeld honderd leden heeft en vijf nieuwe profielen in aanmerking komen voor het publiek, wordt het exporteren naar uw bestemming stapsgewijs uitgevoerd en worden alleen de vijf nieuwe profielen opgenomen.

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.

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 wordt teweeggebracht wanneer een profiel voor kwalificeert of één van drie in kaart gebrachte publiek weggaat. In de gegevensuitvoer, kan het segmentMembership voorwerp (zie ​ Geëxporteerde Gegevens ​ hieronder) ook unmapped publiek omvatten, als dat profiel een lid van hen is en zij het zelfde fusiebeleid delen zoals het publiek dat de uitvoer teweegbracht. Bijvoorbeeld, als een profiel voor de Klant met het 1} publiek van de Auto's DeLorean kwalificeert {maar ook een lid van de Gecontroleerde "Terug naar de Toekomstige"film en de fictiefondsen van de Wetenschap publiek is, verschijnen die twee publiek ook in voorwerp-op voorwaarde zij het zelfde fusiebeleid met de segmentMembership Klant met de Cars van DeLorean {8 delen publiek.

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 creeert en een publiek in kaart brengt aan het, exporteert Experience Platform historische publiekskwalificatiegegevens naar de bestemming. 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

Uw geëxporteerde Experience Platform-gegevens worden in JSON-indeling in uw HTTP-bestemming geplaatst. De onderstaande exportbewerking bevat bijvoorbeeld een profiel dat is gekwalificeerd voor een bepaald publiek, lid is van een ander publiek en een ander publiek verlaat. 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": {
        "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"
          },
          "354e086f-2e11-49a2-9e39-e5d9a76be683": {
            "lastQualificationTime": "2020-04-15T02:41:50+0000",
            "status": "realized"
          }
        }
      }

"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

95 percent van de tijd, probeert Experience Platform om een productietolatie 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.

Wanneer aanvragen naar de HTTP API-bestemming mislukken, worden deze twee keer opgeslagen en opnieuw uitgevoerd.

Problemen oplossen troubleshooting

Om betrouwbare gegevenslevering te verzekeren en onderbreking kwesties te vermijden, zorg ervoor dat uw eindpunt van HTTP binnen 2 seconden aan Experience Platform verzoeken, zoals gespecificeerd in de ​ eerste vereisten ​ sectie antwoordt. Reacties die langer duren, resulteren in time-outfouten.