HTTP API-anslutning

Översikt

VIKTIGT

Det här målet är bara tillgängligt för Adobe Real-time Customer Data Platform Ultimate kunder.

HTTP API-målet är en Adobe Experience Platform direktuppspelningsmål 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 in Adobe Experience Platform.

Användningsfall

Med HTTP API-målet kan du exportera XDM-profildata och målgruppssegment till generiska HTTP-slutpunkter. Där kan du köra dina 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.

Exportera typ och frekvens

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

Objekt Typ Anteckningar
Exporttyp Profile-based Du exporterar alla medlemmar i ett segment tillsammans med önskade schemafält (till exempel: e-postadress, telefonnummer, efternamn), som du har valt på mappningsskärmen på arbetsflöde för målaktivering.
Exportfrekvens Streaming Direktuppspelningsmål är alltid på API-baserade anslutningar. Så snart en profil uppdateras i Experience Platform baserat på segmentutvärdering skickar kopplingen uppdateringen nedåt till målplattformen. Läs mer om mål för direktuppspelning.

Förutsättningar

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:

  • Du måste ha en HTTP-slutpunkt som stöder REST API.
  • HTTP-slutpunkten måste ha stöd för Experience Platform-profilschemat. Ingen omvandling till ett nyttolastschema från tredje part stöds i HTTP API-målet. Se exporterade data för ett exempel på utdataschemat för Experience Platform.
  • HTTP-slutpunkten måste ha stöd för rubriker.
TIPS

Du kan också använda Adobe Experience Platform Destination SDK för att konfigurera en integrering och skicka Experience Platform-profildata till en HTTP-slutpunkt.

IP-adress tillåtelselista

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

Autentiseringstyper som stöds

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

  • HTTP-slutpunkt utan autentisering;
  • Autentisering av innehavartoken;
  • Autentiseringsuppgifter för OAuth 2.0-klient autentisering med innehållsformuläret, med client ID, client secret och grant type i HTTP-begärans brödtext, vilket visas i exemplet nedan.
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

VIKTIGT

Om du vill ansluta till målet behöver du Manage Destinations åtkomstkontrollbehörighet. Läs åtkomstkontroll - översikt eller kontakta produktadministratören för att få de behörigheter som krävs.

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

Autentiseringsinformation

Autentisering av innehavartoken

Om du väljer Bearer token autentiseringstyp för att ansluta till HTTP-slutpunkten, ange fälten nedan och markera Connect to destination:

Bild av gränssnittsskärmen där du kan ansluta till HTTP API-målet med autentisering av innehavartoken

  • Bearer token: infoga bearer-token för att autentisera till din HTTP-plats.

Ingen autentisering

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

Bild av gränssnittsskärmen där du kan ansluta till HTTP API-målet utan autentisering

När du har valt den här autentiseringen öppen behöver du bara välja Connect to destination och anslutningen till slutpunkten har upprättats.

Lösenordsautentisering för OAuth 2

Om du väljer OAuth 2 Password autentiseringstyp för att ansluta till HTTP-slutpunkten, ange fälten nedan och markera Connect to destination:

Bild av gränssnittsskärmen där du kan ansluta till HTTP API-målet med OAuth 2 med lösenordsautentisering

  • Access Token URL: Den URL på din sida som utfärdar åtkomsttoken och, om du vill, uppdatera tokens.
  • Client ID: The client ID som ditt system tilldelar Adobe Experience Platform.
  • Client Secret: The client secret som ditt system tilldelar Adobe Experience Platform.
  • Username: Användarnamnet som ger åtkomst till HTTP-slutpunkten.
  • Password: Lösenordet för att komma åt HTTP-slutpunkten.

Autentisering med OAuth 2-klientautentiseringsuppgifter

Om du väljer OAuth 2 Client Credentials autentiseringstyp för att ansluta till HTTP-slutpunkten, ange fälten nedan och markera Connect to destination:

Bild av gränssnittsskärmen där du kan ansluta till HTTP API-målet med hjälp av OAuth 2 med autentisering av klientautentiseringsuppgifter

  • Access Token URL: Den URL på din sida som utfärdar åtkomsttoken och, om du vill, uppdatera tokens.
  • Client ID: The client ID som ditt system tilldelar Adobe Experience Platform.
  • Client Secret: The client secret som ditt system tilldelar Adobe Experience Platform.
  • Client Credentials Type: Välj den typ av OAuth2-klientautentiseringsuppgifter som stöds av din slutpunkt:
    • Body Form Encoded: I det här fallet client ID och client secret ingår i själva begäran skickas till ditt mål. Se till exempel Autentiseringstyper som stöds -avsnitt.
    • Basic Authorization: I det här fallet client ID och client secret ingår i en Authorization header efter att base64-kodats och skickats till ditt mål. Se till exempel Autentiseringstyper som stöds -avsnitt.

Fyll i målinformation

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.

Bild av gränssnittsskärmen som visar slutförda fält för HTTP-målinformationen

  • Name: Ange ett namn som du känner igen det här målet med i framtiden.
  • Description: Ange en beskrivning som hjälper dig att identifiera det här målet i framtiden.
  • Headers: Ange eventuella anpassade rubriker som du vill ska ingå i målanropen, enligt följande format: header1:value1,header2:value2,...headerN:valueN.
  • HTTP Endpoint: URL:en för HTTP-slutpunkten dit du vill skicka profildata.
  • Query parameters: Du kan också lägga till frågeparametrar till HTTP-slutpunkts-URL:en. Formatera de frågeparametrar som du använder så här: parameter1=value&parameter2=value.
  • Include Segment Names: Växla om du vill att dataexporten ska inkludera namnen på de segment som du exporterar. Ett exempel på en dataexport med det här alternativet markerat finns i Exporterade data vidare nedan.
  • Include Segment Timestamps: Växla om du vill att dataexporten ska inkludera UNIX-tidsstämpeln när segmenten skapades och uppdaterades, samt UNIX-tidsstämpeln när segmenten mappades till målet för aktiveringen. Ett exempel på en dataexport med det här alternativet markerat finns i Exporterade data vidare nedan.

Aktivera aviseringar

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 status för ditt dataflöde. Mer information om varningar finns i guiden prenumerera på destinationsvarningar med hjälp av användargränssnittet.

När du är klar med informationen för målanslutningen väljer du Next.

Aktivera segment till den här destinationen

VIKTIGT

Om du vill aktivera data måste du ha Manage Destinations, Activate Destinations, View Profiles och View Segments behörigheter för åtkomstkontroll. Läs åtkomstkontroll - översikt eller kontakta produktadministratören för att få de behörigheter som krävs.

Se Aktivera målgruppsdata till exportmål för direktuppspelningsprofiler om du vill ha instruktioner om hur du aktiverar målgruppssegment till det här målet.

Målattribut

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

Beteende vid export av profiler

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

  • Profiluppdateringen bestäms av en ändring av segmentmedlemskapet för minst ett av segmenten som är mappat till målet. Profilen har till exempel kvalificerats för ett av de segment som är mappade till målet eller har avslutat ett av de segment som är mappade till målet.
  • Profiluppdateringen bestäms av en ändring i identitetskarta. En profil som redan är kvalificerad för ett av de segment som är mappade till målet har till exempel lagts till som en ny identitet i attributet för identitetskarta.
  • Profiluppdateringen bestäms av en attributändring för minst ett av attributen som är mappade till målet. Ett av attributen som är mappade till målet i mappningssteget läggs till i en profil.

I alla de fall som beskrivs ovan exporteras endast de profiler där relevanta uppdateringar har gjorts till ditt mål. Om ett segment som är mappat till målflödet till exempel har hundra medlemmar och fem nya profiler är kvalificerade för segmentet, kommer exporten till målet att vara inkrementell och endast innehålla de fem nya profilerna.

Observera att alla mappade attribut exporteras för en profil, oavsett var ändringarna finns. I exemplet ovan exporteras alltså alla mappade attribut för de fem nya profilerna även om attributen inte har ändrats.

Vad avgör en dataexport och vad som ingår i exporten

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

Vad avgör en målexport Vad som ingår i målexporten
  • Kopplade attribut och segment fungerar som referens för en målexport. Det innebär att om ett mappat segment ändrar lägen (från null till realiserad eller från realiserad/befintlig till befintlig) eller om mappade attribut uppdateras, kommer en målexport att startas om.
  • Eftersom identiteter för närvarande inte kan mappas till HTTP API-mål, bestämmer ändringar i en viss profil även målexporter.
  • En ändring för ett attribut definieras som en uppdatering för attributet, oavsett om det är samma värde eller inte. Det innebär att en överskrivning av ett attribut betraktas som en ändring även om värdet i sig inte har ändrats.
  • Alla segment (med den senaste medlemskapsstatusen), oavsett om de är mappade i dataflödet eller inte, ingår i segmentMembership -objekt.
  • Alla identiteter i identityMap -objekt ingår också (Experience Platform stöder för närvarande inte identitetsmappning i HTTP API-målet).
  • Endast mappade attribut inkluderas i målexporten.

Tänk dig till exempel det här dataflödet till ett HTTP-mål där tre segment är markerade i dataflödet och fyra attribut är mappade till målet.

Måldataflöde för HTTP API

En profilexport till målet kan bestämmas av en profil som kvalificerar för eller avslutar en av tre mappade segment. I dataexporten kan du dock segmentMembership objekt (se Exporterade data nedan) kan andra omappade segment visas om den aktuella profilen är medlem i dem. Om en profil kvalificerar sig för kunden med DeLorean Cars-segmentet men även är medlem i "Tillbaka till framtiden"-segmentet för film- och science fiction-fans, kommer dessa två andra segment också att finnas i segmentMembership dataexportens objekt, även om dessa inte är mappade i dataflödet.

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

När du lägger till ett nytt segment till ett befintligt mål, eller när du skapar ett nytt mål och mappningssegment till det, exporterar Experience Platform data för historiska segmentkvalificeringar till målet. Profiler som är kvalificerade för segmentet före segmentet lades till i målet och exporteras till målet inom ungefär en timme.

Exporterade data

Dina exporterade Experience Platform data får plats i HTTP mål i JSON-format. Exporten nedan innehåller till exempel en profil som har kvalificerats för ett visst segment, är medlem i ett annat segment och har avslutat ett annat segment. 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":"existing"
      },
      "947c1c46-008d-40b0-92ec-3af86eaf41c1":{
         "lastQualificationTime":"2021-08-25T23:37:33Z",
         "status":"existing"
      },
      "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 användargränssnittsinställningar du har valt i anslutningsmålflödet för Include Segment Names och Include Segment Timestamps alternativ:

 Exemplet på dataexport nedan innehåller segmentnamn i segmentMembership section
"segmentMembership": {
        "ups": {
          "5b998cb9-9488-4ec3-8d95-fa8338ced490": {
            "lastQualificationTime": "2019-04-15T02:41:50+0000",
            "status": "existing",
            "createdAt": 1648553325000,
            "updatedAt": 1648553330000,
            "mappingCreatedAt": 1649856570000,
            "mappingUpdatedAt": 1649856570000,
            "name": "First name equals John"
          }
        }
      }
 Exemplet på dataexport nedan innehåller segmenttidsstämplar i segmentMembership section
"segmentMembership": {
        "ups": {
          "5b998cb9-9488-4ec3-8d95-fa8338ced490": {
            "lastQualificationTime": "2019-04-15T02:41:50+0000",
            "status": "existing",
            "createdAt": 1648553325000,
            "updatedAt": 1648553330000,
            "mappingCreatedAt": 1649856570000,
            "mappingUpdatedAt": 1649856570000,
          }
        }
      }

Begränsningar och återförsöksprincip

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

Om det uppstår misslyckade begäranden till HTTP API-målet, lagrar Experience Platform de misslyckade förfrågningarna och försöker skicka dem till slutpunkten två gånger.

På denna sida