[Ultimate]{class="badge positive"}

HTTP API-anslutning

Översikt overview

HTTP API-målet är ett Experience Platform-mål för direktuppspelning som hjälper dig att skicka profildata till HTTP-slutpunkter från tredje part.

Om du vill skicka profildata till HTTP-slutpunkter måste du först ansluta till målet i Experience Platform.

Användningsfall use-cases

Använd HTTP API-målet för att exportera XDM-profildata och målgrupper till generiska HTTP-slutpunkter. Där kan du köra egna analyser eller utföra andra åtgärder du kan behöva för profildata som exporterats från Experience Platform.

HTTP-slutpunkter kan antingen vara kundernas egna system eller tredjepartslösningar.

Målgrupper supported-audiences

I det här avsnittet beskrivs vilka typer av målgrupper du kan exportera till det här målet.

Målgrupper som stöds av olika typer av målgruppsdata:

Exportera typ och frekvens export-type-frequency

Se tabellen nedan för information om exporttyp och frekvens för destinationen.

Förutsättningar prerequisites

Om du vill använda HTTP API-målet för att exportera data från Experience Platform måste du uppfylla följande krav:

Stöd och certifikat för mTLS-protokoll mtls-protocol-support

Du kan använda Mutual Transport Layer Security (mTLS) för att säkerställa förbättrad säkerhet i utgående anslutningar till HTTP API-målanslutningarna.

mTLS är ett protokoll för ömsesidig autentisering som ser till att båda parter delar information är de som gör anspråk på att vara innan data delas. mTLS innehåller ytterligare ett steg jämfört med standard-TLS, där servern också begär och verifierar klientens certifikat medan klienten verifierar serverns certifikat.

mTLS-överväganden mtls-considerations

mTLS-stöd för HTTP API-mål gäller endast för den datamottagningsslutpunkt där profilexporter skickas (fältet HTTP Endpoint i målinformationen).

Konfigurera mTLS för dataexport configuring-mtls

Om du vill använda mTLS med HTTP API-mål måste TLS-protokoll vara inaktiverade på sidan HTTP Endpoint (slutpunkt för datamottagning) som du konfigurerar på sidan målinformation och endast mTLS aktiverat. Om TLS 1.2-protokollet fortfarande är aktiverat på slutpunkten skickas inget certifikat för klientautentisering. Det innebär att om du vill använda mTLS med ditt HTTP API-mål, måste slutpunkten för datamottagningsservern vara en anslutningsslutpunkt som bara är aktiverad för mTLS.

Hämta och inspektera certifikatinformation certificate

Om du vill inspektera certifikatinformation som t.ex. Common Name (CN) och Subject Alternative Names (SAN) för ytterligare validering från tredje part använder du API:t för att hämta certifikatet och extrahera fälten från svaret.

Mer information finns i dokumentationen för slutpunkten för det offentliga certifikatet.

IP-adress tillåtelselista ip-address-allowlist

För att uppfylla kundernas säkerhets- och kompatibilitetskrav tillhandahåller Experience Platform en lista med statiska IP-adresser som du kan tillåtslista för HTTP API-destinationen. Se IP-adressen tillåtelselista för direktuppspelningsmål för en fullständig lista över IP-adresser som ska tillåtslista.

Autentiseringstyper som stöds supported-authentication-types

HTTP API-målet stöder flera autentiseringstyper för HTTP-slutpunkten:

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'

Anslut till målet connect-destination

Om du vill ansluta till det här målet följer du stegen som beskrivs i självstudiekursen för destinationskonfiguration. När du ansluter till det här målet måste du ange följande information:

Autentiseringsinformation authentication-information

Autentisering av innehavartoken bearer-token-authentication

Om du väljer autentiseringstypen Bearer token för att ansluta till HTTP-slutpunkten anger du informationen nedan och väljer Connect to destination:

Ingen autentisering no-authentication

Om du väljer autentiseringstypen None för att ansluta till HTTP-slutpunkten:

När du väljer det här autentiseringsalternativet behöver du bara välja Connect to destination och anslutningen till slutpunkten är upprättad.

Lösenordsautentisering för OAuth 2 oauth-2-password-authentication

Om du väljer autentiseringstypen OAuth 2 Password för att ansluta till HTTP-slutpunkten anger du informationen nedan och väljer Connect to destination:

Autentisering med OAuth 2-klientautentiseringsuppgifter oauth-2-client-credentials-authentication

Om du väljer autentiseringstypen OAuth 2 Client Credentials för att ansluta till HTTP-slutpunkten anger du informationen nedan och väljer Connect to destination:

Fyll i målinformation destination-details

Om du vill konfigurera information för målet fyller du i de obligatoriska och valfria fälten nedan. En asterisk bredvid ett fält i användargränssnittet anger att fältet är obligatoriskt.

Aktivera aviseringar enable-alerts

Du kan aktivera varningar för att få meddelanden om dataflödets status till ditt mål. Välj en avisering i listan om du vill prenumerera och få meddelanden om statusen för ditt dataflöde. Mer information om varningar finns i guiden om att prenumerera på målvarningar med användargränssnittet.

Välj Next när du är klar med att ange information för målanslutningen.

Aktivera målgrupper till det här målet activate

Se Aktivera målgruppsdata för att direktuppspela profilexportmål för instruktioner om hur du aktiverar målgrupper till det här målet.

Målattribut attributes

I steget Select attributes rekommenderar Adobe att du väljer en unik identifierare från ditt union-schema. Välj den unika identifieraren och eventuella andra XDM-fält som du vill exportera till målet.

Beteende vid export av profiler profile-export-behavior

Experience Platform optimerar beteendet för profilexport till ditt HTTP API-mål, så att endast data exporteras till API-slutpunkten när relevanta uppdateringar av en profil har gjorts efter målgruppsklassificering eller andra viktiga händelser. Profiler exporteras till ditt mål i följande situationer:

I alla de fall som beskrivs ovan exporteras endast de profiler där relevanta uppdateringar har gjorts till ditt mål. Om en målgrupp som mappats till målflödet till exempel har hundra medlemmar och fem nya profiler är kvalificerade för målgruppen, är exporten till målplatsen inkrementell och inkluderar bara de fem nya profilerna.

Vad avgör en dataexport och vad som ingår i exporten what-determines-export-what-is-included

När det gäller data som exporteras för en viss profil är det viktigt att förstå de två olika begreppen vad som avgör en dataexport till HTTP API-målet och vilka data som inkluderas i exporten.

Tänk dig till exempel det här dataflödet till ett HTTP-mål där tre målgrupper har valts i dataflödet och fyra attribut mappas till målet.

En profilexport till målet utlöses när en profil kvalificerar för eller avslutar en av de tre mappade målgrupperna. I dataexporten kan objektet segmentMembership (se Exporterade data nedan) även innehålla omappade målgrupper, om profilen är medlem av dem och de delar samma sammanfogningsprincip som målgruppen som utlöste exporten. Om en profil till exempel kvalificerar sig för målgruppen Kund med DeLorean Cars men även är medlem av filmerna Bevakade"Tillbaka till framtiden" och Science fiction fans , visas även dessa två målgrupper i objektet segmentMembership , förutsatt att de delar samma sammanslagningsprincip med Kund med DeLorean Cars{8} målgrupp.

När det gäller profilattribut kommer alla ändringar av de fyra attribut som mappas ovan att avgöra målexporten och alla de fyra mappade attributen som finns i profilen kommer att finnas i dataexporten.

Bakgrundsfyllning av historiska data historical-data-backfill

När du lägger till en ny målgrupp till ett befintligt mål, eller när du skapar ett nytt mål och mappar målgrupper till det, exporterar Experience Platform data om målgruppens historiska kvalifikationer till målet. Profiler som är kvalificerade för målgruppen innan målgruppen lades till i målet exporteras till målet inom ungefär en timme.

Exporterade data exported-data

Dina exporterade Experience Platform-data kommer in i ditt HTTP-mål i JSON-format. Exporten nedan innehåller till exempel en profil som har kvalificerats för en viss målgrupp, som är medlem av en annan målgrupp och som har lämnat en annan. Exporten innehåller också profilattributets förnamn, efternamn, födelsedatum och personlig e-postadress. Identiteterna för den här profilen är ECID och e-post.

{
  "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"
      }
    ]
  }
}

Nedan visas ytterligare exempel på exporterade data, beroende på vilka UI-inställningar du har valt i anslutningsmålflödet för alternativen Include Segment Names och 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
          }
        }
      }

Begränsningar och återförsöksprincip limits-retry-policy

95 % av tiden försöker Experience Platform att erbjuda en genomströmningslatens på mindre än 10 minuter för skickade meddelanden med en hastighet på mindre än 10 000 begäranden per sekund för varje dataflöde till en HTTP-destination.

När begäranden till HTTP API-målet misslyckas, lagrar Experience Platform dem och försöker igen två gånger.

Felsökning troubleshooting

För att säkerställa tillförlitlig dataleverans och undvika timeoutproblem bör du kontrollera att HTTP-slutpunkten svarar på Experience Platform-förfrågningar inom 2 sekunder, enligt vad som anges i avsnittet Krav . Svar som tar längre tid resulterar i timeoutfel.