[Ultimate]{class="badge positive"}
Connessione API HTTP
Panoramica overview
La destinazione API HTTP è un Adobe Experience Platform destinazione di streaming che consente di inviare i dati del profilo agli endpoint HTTP di terze parti.
Per inviare i dati del profilo agli endpoint HTTP, devi prima connettersi alla destinazione in Adobe Experience Platform.
Casi d’uso use-cases
La destinazione API HTTP consente di esportare i dati di profilo XDM e i tipi di pubblico in endpoint HTTP generici. A questo punto puoi eseguire analisi personalizzate o eseguire qualsiasi altra operazione necessaria sui dati del profilo esportati da Experience Platform.
Gli endpoint HTTP possono essere sistemi propri del cliente o soluzioni di terze parti.
Tipi di pubblico supportati supported-audiences
Questa sezione descrive quali tipi di pubblico puoi esportare in questa destinazione.
Tipo e frequenza di esportazione export-type-frequency
Per informazioni sul tipo e sulla frequenza di esportazione della destinazione, consulta la tabella seguente.
Prerequisiti prerequisites
Per utilizzare la destinazione API HTTP per esportare dati da Experience Platform, è necessario soddisfare i seguenti prerequisiti:
- È necessario disporre di un endpoint HTTP che supporti l’API REST.
- L’endpoint HTTP deve supportare lo schema del profilo di Experience Platform. Nella destinazione API HTTP non è supportata alcuna trasformazione in uno schema di payload di terze parti. Consulta la sezione dati esportati per un esempio dello schema di output Experience Platform.
- L'endpoint HTTP deve supportare le intestazioni.
Supporto e certificato del protocollo mTLS mtls-protocol-support
È possibile utilizzare Mutual Transport Layer Security (mTLS) per garantire una maggiore sicurezza nelle connessioni in uscita alle connessioni di destinazione API HTTP.
mTLS è un metodo di sicurezza end-to-end per l’autenticazione reciproca che garantisce che entrambe le parti che condividono le informazioni siano chi affermano di essere prima che i dati vengano condivisi. mTLS include un passaggio aggiuntivo rispetto a TLS, in cui il server richiede anche il certificato del client e lo verifica alla fine.
Se si desidera utilizzare mTLS con HTTP API destinazioni, l'indirizzo server inserito nel dettagli della destinazione la pagina deve avere TLS protocolli disabilitati e solo mTLS abilitato. Se il TLS Il protocollo 1.2 è ancora abilitato sull'endpoint. Nessun certificato inviato per l'autenticazione client. Ciò significa che per utilizzare mTLS con il HTTP API destinazione, l'endpoint del server di "ricezione" deve essere un mTLSEndpoint di connessione abilitato solo da.
Scarica certificato certificate
Se desideri controllare il Common Name (CN) e Subject Alternative Names (SAN) per eseguire un’ulteriore convalida di terze parti, puoi scaricare il certificato seguente:
Indirizzo IP inserisco nell'elenco Consentiti ip-address-allowlist
Per soddisfare i requisiti di sicurezza e conformità dei clienti, Experience Platform inserire nell'elenco Consentiti fornisce un elenco di IP statici che puoi per la destinazione API HTTP. Fai riferimento a INSERIRE NELL'ELENCO CONSENTITI Indirizzo IP per le destinazioni di streaming inserire nell'elenco Consentiti per l’elenco completo degli IP da.
Tipi di autenticazione supportati supported-authentication-types
La destinazione API HTTP supporta diversi tipi di autenticazione per l’endpoint HTTP:
- Endpoint HTTP senza autenticazione;
- Autenticazione token Bearer;
- Credenziali client OAuth 2.0 autenticazione con il modulo del corpo, con client ID, client secret, e grant type nel corpo della richiesta HTTP, come illustrato nell’esempio seguente.
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>'
- Credenziali client OAuth 2.0 con autorizzazione di base, con un’intestazione di autorizzazione che contiene il codice URL client ID e 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'
Connettersi alla destinazione connect-destination
Per connettersi a questa destinazione, seguire i passaggi descritti in esercitazione sulla configurazione della destinazione. Quando ti connetti a questa destinazione, devi fornire le seguenti informazioni:
Informazioni di autenticazione authentication-information
Autenticazione token Bearer bearer-token-authentication
Se si seleziona la Token Bearer tipo di autenticazione per connettersi all’endpoint HTTP, inserisci i campi seguenti e seleziona Connetti alla destinazione:
- Token Bearer: inserisci il token Bearer per l’autenticazione nella posizione HTTP.
Nessuna autenticazione no-authentication
Se si seleziona la Nessuno tipo di autenticazione per connettersi all’endpoint HTTP:
Quando selezioni questa autenticazione aperta, devi solo selezionare Connetti alla destinazione e viene stabilita la connessione all’endpoint.
Autenticazione password OAuth 2 oauth-2-password-authentication
Se si seleziona la Password OAuth 2 tipo di autenticazione per connettersi all’endpoint HTTP, inserisci i campi seguenti e seleziona Connetti alla destinazione:
- URL token di accesso: URL sul lato dell’utente che rilascia i token di accesso e, facoltativamente, aggiorna i token.
- ID client: Il client ID che il sistema assegna a Adobe Experience Platform.
- Segreto client: Il client secret che il sistema assegna a Adobe Experience Platform.
- Nome utente: nome utente per accedere all’endpoint HTTP.
- Password: password per accedere all’endpoint HTTP.
Autenticazione credenziali client OAuth 2 oauth-2-client-credentials-authentication
Se si seleziona la Credenziali client OAuth 2 tipo di autenticazione per connettersi all’endpoint HTTP, inserisci i campi seguenti e seleziona Connetti alla destinazione:
-
URL token di accesso: URL sul lato dell’utente che rilascia i token di accesso e, facoltativamente, aggiorna i token.
-
ID client: Il client ID che il sistema assegna a Adobe Experience Platform.
-
Segreto client: Il client secret che il sistema assegna a Adobe Experience Platform.
-
Tipo di credenziali client: seleziona il tipo di concessione di credenziali client OAuth2 supportata dall’endpoint:
- Corpo del modulo codificato: in questo caso, il client ID e client secret sono inclusi nel corpo della richiesta inviato alla tua destinazione. Ad esempio, consulta Tipi di autenticazione supportati sezione.
- Autorizzazione di base: in questo caso, il client ID e client secret sono inclusi in un
Authorizationintestazione dopo la codifica base64 e l'invio alla destinazione. Ad esempio, consulta Tipi di autenticazione supportati sezione.
Inserire i dettagli della destinazione destination-details
Per configurare i dettagli per la destinazione, compila i campi obbligatori e facoltativi seguenti. Un asterisco accanto a un campo nell’interfaccia utente indica che il campo è obbligatorio.
- Nome: immetti un nome con cui riconoscerai questa destinazione in futuro.
- Descrizione: immetti una descrizione che ti aiuterà a identificare questa destinazione in futuro.
- Intestazioni: immetti le intestazioni personalizzate che desideri includere nelle chiamate di destinazione, seguendo questo formato:
header1:value1,header2:value2,...headerN:valueN. - Endpoint HTTP: URL dell’endpoint HTTP a cui desideri inviare i dati del profilo.
- Parametri di query: facoltativamente, puoi aggiungere parametri di query all’URL dell’endpoint HTTP. I parametri di query che vuoi utilizzare devono essere nel formato seguente:
parameter1=value¶meter2=value. - Includi nomi segmento: attiva questa opzione se desideri che l’esportazione dei dati includa i nomi dei tipi di pubblico che stai esportando. Per un esempio di esportazione di dati con questa opzione selezionata, fai riferimento al Dati esportati più avanti.
- Includi marche temporali segmento: attiva questa opzione se desideri che l’esportazione dei dati includa la marca temporale UNIX di quando i tipi di pubblico sono stati creati e aggiornati, nonché la marca temporale UNIX di quando i tipi di pubblico sono stati mappati sulla destinazione per l’attivazione. Per un esempio di esportazione di dati con questa opzione selezionata, fai riferimento al Dati esportati più avanti.
Abilita avvisi enable-alerts
Puoi abilitare gli avvisi per ricevere notifiche sullo stato del flusso di dati verso la tua destinazione. Seleziona un avviso dall’elenco per abbonarti e ricevere notifiche sullo stato del flusso di dati. Per ulteriori informazioni sugli avvisi, consulta la guida su abbonamento agli avvisi sulle destinazioni tramite l’interfaccia utente.
Una volta completate le informazioni sulla connessione di destinazione, seleziona Successivo.
Attivare tipi di pubblico in questa destinazione activate
- Per attivare i dati, è necessario Visualizza destinazioni, Attivare le destinazioni, Visualizza profili, e Visualizzare segmenti autorizzazioni di controllo degli accessi. Leggi le panoramica sul controllo degli accessi oppure contatta l’amministratore del prodotto per ottenere le autorizzazioni necessarie.
- Valutazione dei criteri di consenso non è attualmente supportato nelle esportazioni nella destinazione API HTTP. Ulteriori informazioni.
Consulta Attivare i dati del pubblico nelle destinazioni di esportazione del profilo di streaming per istruzioni sull’attivazione dei tipi di pubblico in questa destinazione.
Attributi di destinazione attributes
In Seleziona attributi , l'Adobe consiglia di selezionare un identificatore univoco dal schema di unione. Seleziona l’identificatore univoco e tutti gli altri campi XDM da esportare nella destinazione.
Comportamento di esportazione del profilo profile-export-behavior
Experience Platform ottimizza il comportamento di esportazione del profilo nella destinazione API HTTP per esportare i dati nell’endpoint API solo quando si sono verificati aggiornamenti rilevanti a un profilo in seguito alla qualifica di un pubblico o ad altri eventi significativi. I profili vengono esportati nella destinazione nelle seguenti situazioni:
- L’aggiornamento del profilo è stato determinato da una modifica nell’appartenenza al pubblico per almeno uno dei tipi di pubblico mappati alla destinazione. Ad esempio, il profilo è idoneo per uno dei tipi di pubblico mappati sulla destinazione o è uscito da uno dei tipi di pubblico mappati sulla destinazione.
- L’aggiornamento del profilo è stato determinato da una modifica nella mappa identità. Ad esempio, a un profilo che si era già qualificato per uno dei tipi di pubblico mappati sulla destinazione è stata aggiunta una nuova identità nell’attributo identity map.
- L’aggiornamento del profilo è stato determinato da una modifica degli attributi per almeno uno degli attributi mappati alla destinazione. Ad esempio, uno degli attributi mappati sulla destinazione nel passaggio di mappatura viene aggiunto a un profilo.
In tutti i casi descritti sopra, solo i profili in cui si sono verificati aggiornamenti rilevanti vengono esportati nella destinazione. Ad esempio, se un pubblico mappato al flusso di destinazione ha un centinaio di membri e cinque nuovi profili sono idonei per il segmento, l’esportazione nella destinazione è incrementale e include solo i cinque nuovi profili.
Tieni presente che tutti gli attributi mappati vengono esportati per un profilo, indipendentemente da dove si trovano le modifiche. Quindi, nell’esempio precedente, tutti gli attributi mappati per questi cinque nuovi profili verranno esportati anche se gli attributi stessi non sono stati modificati.
Che cosa determina un’esportazione di dati e cosa è incluso nell’esportazione what-determines-export-what-is-included
Per quanto riguarda i dati esportati per un determinato profilo, è importante comprendere i due diversi concetti di cosa determina un’esportazione di dati nella destinazione API HTTP e quali dati sono inclusi nell’esportazione.
- Gli attributi e i tipi di pubblico mappati fungono da spunto per un’esportazione di destinazione. Ciò significa che se un pubblico mappato cambia stato (da
nullarealizedo darealizedaexiting) o se vengono aggiornati eventuali attributi mappati, viene avviata un’esportazione di destinazione. - Poiché al momento non è possibile mappare le identità sulle destinazioni API HTTP, anche le modifiche apportate a un’identità in un determinato profilo determinano le esportazioni delle destinazioni.
- Per modifica di un attributo si intende qualsiasi aggiornamento dell'attributo, indipendentemente dal fatto che si tratti o meno dello stesso valore. Ciò significa che una sovrascrittura su un attributo è considerata una modifica anche se il valore stesso non è cambiato.
- Il
segmentMembershipL’oggetto include il pubblico mappato nel flusso di dati di attivazione, per il quale lo stato del profilo è cambiato a seguito di un evento di qualificazione o uscita dal pubblico. Tieni presente che altri tipi di pubblico non mappati per i quali il profilo si è qualificato possono far parte dell’esportazione di destinazione, se tali tipi di pubblico appartengono allo stesso criterio di unione come il pubblico mappato nel flusso di dati di attivazione. - Tutte le identità in
identityMapL’oggetto è incluso anche (Experience Platform attualmente non supporta la mappatura identità nella destinazione API HTTP). - Nell’esportazione della destinazione sono inclusi solo gli attributi mappati.
Ad esempio, considera questo flusso di dati come una destinazione HTTP in cui tre tipi di pubblico vengono selezionati nel flusso di dati e quattro attributi vengono mappati sulla destinazione.
Un’esportazione di profilo verso la destinazione può essere determinata da un profilo idoneo o in uscita da uno dei tre segmenti mappati. Tuttavia, nell’esportazione dei dati, nella segmentMembership oggetto (vedere Dati esportati sezione seguente), potrebbero essere visualizzati altri tipi di pubblico non mappati, se quel particolare profilo è un membro di essi e se questi condividono lo stesso criterio di unione del pubblico che ha attivato l’esportazione. Se un profilo è idoneo per Cliente con auto DeLorean ma è anche un membro del Guarda "Ritorno al futuro" film e Fantascienza segmenti, quindi anche questi altri due tipi di pubblico saranno presenti nel segmentMembership oggetto dell’esportazione di dati, anche se non sono mappati nel flusso di dati, se condividono lo stesso criterio di unione con Cliente con auto DeLorean segmento.
Dal punto di vista degli attributi di profilo, eventuali modifiche ai quattro attributi mappati in precedenza determineranno un’esportazione di destinazione e uno qualsiasi dei quattro attributi mappati presenti nel profilo sarà presente nell’esportazione di dati.
Recupero dati storici historical-data-backfill
Quando aggiungi un nuovo pubblico a una destinazione esistente o quando crei una nuova destinazione e mappi i tipi di pubblico a essa, Experience Platform esporta i dati storici di qualificazione del pubblico nella destinazione. Profili qualificati per il pubblico prima di il pubblico aggiunto alla destinazione viene esportato nella destinazione entro circa un'ora.
Dati esportati exported-data
Il tuo esportato Experience Platform i dati vengono inseriti nel HTTP destinazione in formato JSON. Ad esempio, l’esportazione seguente contiene un profilo idoneo per un determinato segmento, è membro di altri due segmenti ed è uscito da un altro segmento. L’esportazione include anche l’attributo del profilo nome, cognome, data di nascita e indirizzo e-mail personale. Le identità per questo profilo sono ECID e 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"
}
]
}
}
Di seguito sono riportati ulteriori esempi di dati esportati, a seconda delle impostazioni dell’interfaccia utente selezionate nel flusso di destinazione della connessione per Includi nomi segmento e Includi marche temporali segmento opzioni:
segmentMembership sezione| code language-json |
|---|
|
segmentMembership sezione| code language-json |
|---|
|
Limiti e criteri per nuovi tentativi limits-retry-policy
Nel 95% del tempo, Experience Platform tenta di offrire una latenza di velocità effettiva inferiore a 10 minuti per i messaggi inviati correttamente con una frequenza inferiore a 10.000 richieste al secondo per ogni flusso di dati a una destinazione HTTP.
In caso di richieste non riuscite alla destinazione API HTTP, Experience Platform memorizza le richieste non riuscite e tenta di inviarle all’endpoint due volte.