Connettiti alle destinazioni di streaming e attiva i dati utilizzando l’API del servizio di flusso

Questa esercitazione illustra come utilizzare le chiamate API per connettersi ai dati di Adobe Experience Platform, creare una connessione a una destinazione di archiviazione cloud in streaming (Amazon Kinesis o Azure Event Hubs), creare un flusso di dati per la nuova destinazione creata e attivare i dati per la nuova destinazione creata.

Questa esercitazione utilizza la destinazione Amazon Kinesis in tutti gli esempi, ma i passaggi sono identici per Azure Event Hubs.

Se preferisci utilizzare l’interfaccia utente di Platform per connetterti a una destinazione e attivare i dati, consulta le esercitazioni Connetti una destinazione e Attiva profili e segmenti a una destinazione .

Introduzione

Questa guida richiede una buona comprensione dei seguenti componenti di Adobe Experience Platform:

• Experience Data Model (XDM) System: Il framework standardizzato in base al quale l’Experience Platform organizza i dati sulla customer experience.
• Catalog Service: Catalog è il sistema di registrazione per la posizione dei dati e la derivazione all'interno di Experience Platform.
• Sandbox: Experience Platform fornisce sandbox virtuali che suddividono una singola istanza di Platform in ambienti virtuali separati per sviluppare e sviluppare applicazioni di esperienza digitale.

Le sezioni seguenti forniscono informazioni aggiuntive che sarà necessario conoscere per attivare i dati alle destinazioni di streaming in Platform.

Raccogli credenziali richieste

Per completare i passaggi descritti in questa esercitazione, devi disporre delle seguenti credenziali, a seconda del tipo di destinazioni a cui stai connettendo e attivando i segmenti.

• Per le connessioni Amazon Kinesis: accessKeyId, secretKey, region o connectionUrl
• Per le connessioni Azure Event Hubs: sasKeyName, sasKey, namespace

Lettura di chiamate API di esempio

Questa esercitazione fornisce esempi di chiamate API per dimostrare come formattare le richieste. Questi includono percorsi, intestazioni richieste e payload di richiesta formattati correttamente. Viene inoltre fornito un esempio di codice JSON restituito nelle risposte API. Per informazioni sulle convenzioni utilizzate nella documentazione per le chiamate API di esempio, consulta la sezione su come leggere le chiamate API di esempio nella guida alla risoluzione dei problemi di Experience Platform.

Raccogli i valori delle intestazioni richieste e facoltative

Per effettuare chiamate alle API di Platform, devi prima completare l’ esercitazione sull’autenticazione. Il completamento dell’esercitazione di autenticazione fornisce i valori per ciascuna delle intestazioni richieste in tutte le chiamate API di Experience Platform, come mostrato di seguito:

• Autorizzazione: Portatore {ACCESS_TOKEN}
• x-api-key: {API_KEY}
• x-gw-ims-org-id: {IMS_ORG}

Le risorse in Experience Platform possono essere isolate in sandbox virtuali specifiche. Nelle richieste alle API di Platform, puoi specificare il nome e l’ID della sandbox in cui avrà luogo l’operazione. Si tratta di parametri facoltativi.

• x-sandbox-name: {SANDBOX_NAME}

Tutte le richieste che contengono un payload (POST, PUT, PATCH) richiedono un’intestazione di tipo multimediale aggiuntiva:

• Content-Type: application/json

Documentazione Swagger

In Swagger puoi trovare la documentazione di riferimento associata per tutte le chiamate API in questa esercitazione. Consulta la documentazione API del servizio di flusso su Adobe I/O. È consigliabile utilizzare questa esercitazione e la pagina della documentazione Swagger in parallelo.

Ottieni l’elenco delle destinazioni di streaming disponibili

Come primo passo, devi decidere a quale destinazione di streaming attivare i dati. Per iniziare, esegui una chiamata per richiedere un elenco di destinazioni disponibili a cui puoi collegare e attivare i segmenti. Esegui la seguente richiesta di GET all’endpoint connectionSpecs per restituire un elenco di destinazioni disponibili:

Formato API

GET /connectionSpecs

Richiesta

curl --location --request GET 'https://platform.adobe.io/data/foundation/flowservice/connectionSpecs' \
--header 'accept: application/json' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}'

Risposta

Una risposta corretta contiene un elenco delle destinazioni disponibili e dei relativi identificatori univoci (id). Memorizza il valore della destinazione che intendi utilizzare, come sarà necessario in ulteriori passaggi. Ad esempio, se desideri collegare e consegnare segmenti a Amazon Kinesis o Azure Event Hubs, cerca il seguente frammento nella risposta:

{
    "id": "86043421-563b-46ec-8e6c-e23184711bf6",
  "name": "Amazon Kinesis",
  ...
  ...
}

{
    "id": "bf9f5905-92b7-48bf-bf20-455bc6b60a4e",
  "name": "Azure Event Hubs",
  ...
  ...
}

Connettersi ai dati di Experience Platform

Successivamente, devi connetterti ai dati di Experience Platform, in modo da poter esportare i dati di profilo e attivarli nella destinazione desiderata. Si tratta di due sottoregimi descritti di seguito.

1. Innanzitutto, devi eseguire una chiamata per autorizzare l'accesso ai tuoi dati in Experience Platform, configurando una connessione di base.
2. Quindi, utilizzando l'ID di connessione di base, effettuerai un'altra chiamata in cui crei una connessione sorgente, che stabilisce la connessione ai dati del tuo Experience Platform.

Autorizzare l’accesso ai dati in Experience Platform

Formato API

POST /connections

Richiesta

curl --location --request POST 'https://platform.adobe.io/data/foundation/flowservice/connections' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Content-Type: application/json' \
--data-raw '{
            "name": "Base connection to Experience Platform",
            "description": "This call establishes the connection to Experience Platform data",
            "connectionSpec": {
                "id": "{CONNECTION_SPEC_ID}",
                "version": "1.0"
            }
}'

• {CONNECTION_SPEC_ID}: Utilizza l’ID delle specifiche di connessione per il servizio profili - 8a9c3494-9708-43d7-ae3f-cda01e5030e1.

Risposta

Una risposta corretta contiene l'identificatore univoco della connessione di base (id). Memorizza questo valore come necessario nel passaggio successivo per creare la connessione sorgente.

{
    "id": "1ed86558-59b5-42f7-9865-5859b552f7f4"
}

Connettersi ai dati di Experience Platform

Formato API

POST /sourceConnections

Richiesta

curl --location --request POST 'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Content-Type: application/json' \
--data-raw '{
            "name": "Connecting to Profile Service",
            "description": "Optional",
            "connectionSpec": {
                "id": "{CONNECTION_SPEC_ID}",
                "version": "1.0"
            },
            "baseConnectionId": "{BASE_CONNECTION_ID}",
            "data": {
                "format": "json"
            },
            "params" : {}
}'

• {BASE_CONNECTION_ID}: Utilizza l'ID ottenuto nel passaggio precedente.
• {CONNECTION_SPEC_ID}: Utilizza l’ID delle specifiche di connessione per il servizio profili - 8a9c3494-9708-43d7-ae3f-cda01e5030e1.

Risposta

Una risposta corretta restituisce l’identificatore univoco (id) per la nuova connessione sorgente al servizio profilo appena creata. Conferma che la connessione ai dati di Experience Platform è stata completata. Memorizza questo valore come richiesto in un passaggio successivo.

{
    "id": "ed48ae9b-c774-4b6e-88ae-9bc7748b6e97"
}

Connessione alla destinazione streaming

In questo passaggio, stai impostando una connessione alla destinazione di streaming desiderata. Si tratta di due sottoregimi descritti di seguito.

1. Innanzitutto, devi eseguire una chiamata per autorizzare l’accesso alla destinazione streaming, impostando una connessione di base.
2. Quindi, utilizzando l'ID di connessione di base, effettuerai un'altra chiamata in cui crei una connessione di destinazione, che specifica la posizione nell'account di archiviazione in cui verranno inviati i dati esportati, nonché il formato dei dati che verranno esportati.

Autorizzare l'accesso alla destinazione streaming

Formato API

POST /connections

Richiesta

curl --location --request POST 'https://platform.adobe.io/data/foundation/flowservice/connections' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Connection for Amazon Kinesis/ Azure Event Hubs",
    "description": "summer advertising campaign",
    "connectionSpec": {
        "id": "{_CONNECTION_SPEC_ID}",
        "version": "1.0"
    },
    "auth": {
        "specName": "{AUTHENTICATION_CREDENTIALS}",
        "params": { // use these values for Amazon Kinesis connections
            "accessKeyId": "{ACCESS_ID}",
            "secretKey": "{SECRET_KEY}",
            "region": "{REGION}"
        },
        "params": { // use these values for Azure Event Hubs connections
            "sasKeyName": "{SAS_KEY_NAME}",
            "sasKey": "{SAS_KEY}",
            "namespace": "{EVENT_HUB_NAMESPACE}"
        }        
    }
}'

• {CONNECTION_SPEC_ID}: Utilizza l’ID delle specifiche di connessione ottenuto nel passaggio Ottieni l’elenco delle destinazioni disponibili.
• {AUTHENTICATION_CREDENTIALS}: compila il nome della destinazione di streaming: Aws Kinesis authentication credentials o Azure EventHub authentication credentials.
• {ACCESS_ID}: Per Amazon Kinesis le connessioni. ID di accesso per la posizione di archiviazione Kinesis di Amazon.
• {SECRET_KEY}: Per Amazon Kinesis le connessioni. Chiave segreta per la posizione di archiviazione Kinesis di Amazon.
• {REGION}: Per Amazon Kinesis le connessioni. La regione nel tuo Amazon Kinesis account in cui Platform eseguirà lo streaming dei dati.
• {SAS_KEY_NAME}: Per Azure Event Hubs le connessioni. Immettere il nome della chiave SAS. Informazioni sull'autenticazione in Azure Event Hubs con chiavi SAS nella documentazione Microsoft.
• {SAS_KEY}: Per Azure Event Hubs le connessioni. Inserire la chiave SAS. Informazioni sull'autenticazione in Azure Event Hubs con chiavi SAS nella documentazione Microsoft.
• {EVENT_HUB_NAMESPACE}: Per Azure Event Hubs le connessioni. Inserisci lo Azure Event Hubs spazio dei nomi in cui Platform eseguirà lo streaming dei dati. Per ulteriori informazioni, consulta Creare un namespace Event Hubs nella documentazione Microsoft .

Risposta

Una risposta corretta contiene l'identificatore univoco della connessione di base (id). Memorizza questo valore come necessario nel passaggio successivo per creare una connessione di destinazione.

{
    "id": "1ed86558-59b5-42f7-9865-5859b552f7f4"
}

Specificare il percorso di archiviazione e il formato dei dati

Formato API

POST /targetConnections

Richiesta

curl --location --request POST 'https://platform.adobe.io/data/foundation/flowservice/targetConnections' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Amazon Kinesis/ Azure Event Hubs target connection",
    "description": "Connection to Amazon Kinesis/ Azure Event Hubs",
    "baseConnectionId": "{BASE_CONNECTION_ID}",
    "connectionSpec": {
        "id": "{CONNECTION_SPEC_ID}",
        "version": "1.0"
    },
    "data": {
        "format": "json"
    },
    "params": { // use these values for Amazon Kinesis connections
        "stream": "{NAME_OF_DATA_STREAM}", 
        "region": "{REGION}"
    },
    "params": { // use these values for Azure Event Hubs connections
        "eventHubName": "{EVENT_HUB_NAME}"
    }
}'

• {BASE_CONNECTION_ID}: Utilizza l'ID di connessione di base ottenuto nel passaggio precedente.
• {CONNECTION_SPEC_ID}: Utilizza le specifiche di connessione ottenute nel passaggio Ottieni l’elenco delle destinazioni disponibili.
• {NAME_OF_DATA_STREAM}: Per Amazon Kinesis le connessioni. Immetti il nome del flusso di dati esistente nel tuo Amazon Kinesis account. Platform esporta i dati in questo flusso.
• {REGION}: Per Amazon Kinesis le connessioni. La regione nel tuo account Amazon Kinesis in cui Platform eseguirà lo streaming dei tuoi dati.
• {EVENT_HUB_NAME}: Per Azure Event Hubs le connessioni. Inserisci il Azure Event Hub nome in cui Platform eseguirà lo streaming dei dati. Per ulteriori informazioni, consulta Creare un hub eventi nella documentazione Microsoft .

Risposta

Una risposta corretta restituisce l'identificatore univoco (id) per la nuova connessione di destinazione alla destinazione di streaming. Memorizza questo valore come richiesto nei passaggi successivi.

{
    "id": "12ab90c7-519c-4291-bd20-d64186b62da8"
}

Creazione di un flusso di dati

Utilizzando gli ID ottenuti nei passaggi precedenti, ora puoi creare un flusso di dati tra i dati di Experience Platform e la destinazione in cui attiverai i dati. Considera questo passaggio come la costruzione della pipeline, attraverso la quale i dati scorreranno successivamente, tra l’Experience Platform e la destinazione desiderata.

Per creare un flusso di dati, esegui una richiesta POST, come mostrato di seguito, fornendo al tempo stesso i valori indicati di seguito all’interno del payload.

Esegui la seguente richiesta POST per creare un flusso di dati.

Formato API

POST /flows

Richiesta

curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/flows' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d  '{
  "name": "Azure Event Hubs",
  "description": "Azure Event Hubs",
  "flowSpec": {
    "id": "{FLOW_SPEC_ID}",
    "version": "1.0"
  },
  "sourceConnectionIds": [
    "{SOURCE_CONNECTION_ID}"
  ],
  "targetConnectionIds": [
    "{TARGET_CONNECTION_ID}"
  ],
  "transformations": [
    {
      "name": "GeneralTransform",
      "params": {
        "profileSelectors": {
          "selectors": [
            
          ]
        },
        "segmentSelectors": {
          "selectors": [
            
          ]
        }
      }
    }
  ]
}

• {FLOW_SPEC_ID}: L’ID della specifica di flusso per le destinazioni basate su profili è 71471eba-b620-49e4-90fd-23f1fa0174d8. Utilizza questo valore nella chiamata di .
• {SOURCE_CONNECTION_ID}: Utilizza l'ID di connessione sorgente ottenuto nel passaggio Connetti all'Experience Platform.
• {TARGET_CONNECTION_ID}: Utilizza l'ID di connessione di destinazione ottenuto nel passaggio Connetti a destinazione streaming.

Risposta

Una risposta corretta restituisce l'ID (id) del flusso di dati appena creato e un valore etag. Annotare entrambi i valori. come li eseguirai nel passaggio successivo, per attivare i segmenti.

{
    "id": "8256cfb4-17e6-432c-a469-6aedafb16cd5",
    "etag": "8256cfb4-17e6-432c-a469-6aedafb16cd5"
}

Attiva i dati nella nuova destinazione

Dopo aver creato tutte le connessioni e il flusso di dati, ora puoi attivare i dati del profilo sulla piattaforma streaming. In questo passaggio, seleziona i segmenti e gli attributi di profilo che stai inviando alla destinazione e puoi pianificare e inviare i dati alla destinazione.

Per attivare i segmenti nella nuova destinazione, è necessario eseguire un’operazione JSON PATCH, simile all’esempio seguente. Puoi attivare più segmenti e attributi di profilo in una sola chiamata. Per ulteriori informazioni su JSON PATCH, consulta la specifica RFC.

Formato API

PATCH /flows

Richiesta

curl --location --request PATCH 'https://platform.adobe.io/data/foundation/flowservice/flows/{DATAFLOW_ID}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'Content-Type: application/json' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'If-Match: "{ETAG}"' \
--data-raw '[
  {
    "op": "add",
    "path": "/transformations/0/params/segmentSelectors/selectors/-",
    "value": {
      "type": "PLATFORM_SEGMENT",
      "value": {
        "name": "Name of the segment that you are activating",
        "description": "Description of the segment that you are activating",
        "id": "{SEGMENT_ID}"
      }
    }
  },
  {
    "op": "add",
    "path": "/transformations/0/params/profileSelectors/selectors/-",
    "value": {
      "type": "JSON_PATH",
      "value": {
        "operator": "EXISTS",
        "path": "{PROFILE_ATTRIBUTE}"
      }
    }
  }
]

• {DATAFLOW_ID}: Utilizza il flusso di dati ottenuto nel passaggio precedente.
• {ETAG}: Utilizza il tag ottenuto nel passaggio precedente.
• {SEGMENT_ID}: Fornisci l’ID del segmento da esportare a questa destinazione. Per recuperare gli ID dei segmenti per i segmenti che si desidera attivare, vai su https://www.adobe.io/apis/experienceplatform/home/api-reference.html#/, seleziona API Servizio di segmentazione nel menu di navigazione a sinistra e cerca l'operazione GET /segment/definitions in Definizioni dei segmenti.
• {PROFILE_ATTRIBUTE}: Ad esempio, personalEmail.address o person.lastName

Risposta

Cerca una risposta 202 OK. Non viene restituito alcun corpo di risposta. Per verificare che la richiesta fosse corretta, vedi il passaggio successivo, Convalida il flusso di dati.

Convalidare il flusso di dati

Come passaggio finale nell’esercitazione, dovresti verificare che i segmenti e gli attributi di profilo siano stati mappati correttamente al flusso di dati.

Per convalidarlo, esegui la seguente richiesta di GET:

Formato API

GET /flows

Richiesta

curl --location --request PATCH 'https://platform.adobe.io/data/foundation/flowservice/flows/{DATAFLOW_ID}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'Content-Type: application/json' \
--header 'x-sandbox-name: prod' \
--header 'If-Match: "{ETAG}"' 

• {DATAFLOW_ID}: Utilizza il flusso di dati del passaggio precedente.
• {ETAG}: Utilizza il tag del passaggio precedente.

Risposta

La risposta restituita deve includere nel parametro transformations i segmenti e gli attributi di profilo inviati nel passaggio precedente. Di seguito è riportato un parametro di esempio transformations nella risposta:

"transformations": [
    {
        "name": "GeneralTransform",
        "params": {
            "profileSelectors": {
                        "selectors": [
                            {
                                "type": "JSON_PATH",
                                "value": {
                                    "path": "personalEmail.address",
                                    "operator": "EXISTS"
                                }
                            },
                            {
                                "type": "JSON_PATH",
                                "value": {
                                    "path": "person.lastname",
                                    "operator": "EXISTS"
                                }
                            }
                        ]
                    },
            "segmentSelectors": {
                "selectors": [
                    {
                        "type": "PLATFORM_SEGMENT",
                        "value": {
                            "name": "Men over 50",
                            "description": "",
                            "id": "72ddd79b-6b0a-4e97-a8d2-112ccd81bd02"
                        }
                    }
                ]
            }
        }
    }
],

Dati esportati

{
  "person": {
    "email": "yourstruly@adobe.con"
  },
  "segmentMembership": {
    "ups": {
      "72ddd79b-6b0a-4e97-a8d2-112ccd81bd02": {
        "lastQualificationTime": "2020-03-03T21:24:39Z",
        "status": "exited"
      },
      "7841ba61-23c1-4bb3-a495-00d695fe1e93": {
        "lastQualificationTime": "2020-03-04T23:37:33Z",
        "status": "existing"
      }
    }
  },
  "identityMap": {
    "ecid": [
      {
        "id": "14575006536349286404619648085736425115"
      },
      {
        "id": "66478888669296734530114754794777368480"
      }
    ],
    "email_lc_sha256": [
      {
        "id": "655332b5fa2aea4498bf7a290cff017cb4"
      },
      {
        "id": "66baf76ef9de8b42df8903f00e0e3dc0b7"
      }
    ]
  }
}

Utilizzo delle raccolte Postman per connettersi alle destinazioni in streaming

Per collegarti alle destinazioni di streaming descritte in questa esercitazione in modo più semplice, puoi utilizzare Postman.

Postman è uno strumento che puoi utilizzare per effettuare chiamate API e gestire le librerie di chiamate e ambienti predefiniti.

Per questa esercitazione specifica sono state aggiunte le seguenti Postman raccolte:

• AWS Kinesis Postman raccolta
• Azure Event Hubs Postman raccolta

Fai clic qui per scaricare l'archivio delle raccolte.

Ogni raccolta include le richieste e le variabili di ambiente necessarie, rispettivamente per AWS Kinesis e Azure Event Hub.

Come utilizzare le raccolte Postman

Per connettersi correttamente alle destinazioni utilizzando le raccolte Postman allegate, effettua le seguenti operazioni:

• Scarica e installa Postman;
• 🔗 Scaricare e decomprimere le raccolte allegate;
• Importa le raccolte dalle loro cartelle corrispondenti in Postman;
• Compila le variabili d'ambiente secondo le istruzioni del presente articolo;
• Esegui le richieste API da Postman, in base alle istruzioni contenute in questo articolo.

Passaggi successivi

Seguendo questa esercitazione, hai collegato Platform a una delle tue destinazioni di streaming preferite e hai impostato un flusso di dati per la rispettiva destinazione. I dati in uscita possono ora essere utilizzati nella destinazione per l’analisi dei clienti o per qualsiasi altra operazione di dati che desideri eseguire. Per ulteriori informazioni, consulta le pagine seguenti:

• Panoramica sulle destinazioni
• Panoramica del catalogo delle destinazioni