Conectar-se a destinos de streaming e ativar dados usando a API de Serviço de Fluxo

Este tutorial demonstra como usar chamadas de API para se conectar aos dados do Adobe Experience Platform, criar uma conexão com um destino de armazenamento da nuvem de transmissão (Amazon Kinesis ou Hubs de Eventos do Azure), crie um fluxo de dados para o novo destino criado e ative os dados para o novo destino criado.

Este tutorial usa o Amazon Kinesis destino em todos os exemplos, mas as etapas são idênticas para Azure Event Hubs.

Se preferir usar a interface do usuário na Platform para se conectar a um destino e ativar dados, consulte a Conectar um destino e Ativar dados do público-alvo para streaming de destinos de exportação de público tutoriais.

Introdução

Este manual necessita de uma compreensão funcional dos seguintes componentes da Adobe Experience Platform:

• Experience Data Model (XDM) System: a estrutura padronizada pela qual o Experience Platform organiza os dados de experiência do cliente.
• Catalog Service: Catalog é o sistema de registro para localização e linhagem de dados no Experience Platform.
• Sandboxes: o Experience Platform fornece sandboxes virtuais que particionam uma única instância da Platform em ambientes virtuais separados para ajudar a desenvolver aplicativos de experiência digital.

As seções a seguir fornecem informações adicionais que você precisará saber para ativar dados para destinos de transmissão na Platform.

Coletar credenciais necessárias

Para concluir as etapas deste tutorial, você deve ter as credenciais a seguir prontas, dependendo do tipo de destinos aos quais você está se conectando e ativando públicos.

• Para Amazon Kinesis conexões: accessKeyId, secretKey, region ou connectionUrl
• Para Azure Event Hubs conexões: sasKeyName, sasKey, namespace

Leitura de chamadas de API de amostra

Este tutorial fornece exemplos de chamadas de API para demonstrar como formatar suas solicitações. Isso inclui caminhos, cabeçalhos necessários e conteúdos de solicitação formatados corretamente. Também fornece exemplos de JSON retornado nas respostas da API. Para obter informações sobre as convenções usadas na documentação para chamadas de API de exemplo, consulte a seção sobre como ler chamadas de API de exemplo no guia de solução de problemas de Experience Platform.

Colete valores para cabeçalhos obrigatórios e opcionais

Para fazer chamadas para APIs da Platform, primeiro conclua o tutorial de autenticação. Concluir o tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários em todas as chamadas de API de Experience Platform, conforme mostrado abaixo:

• Autorização: Portador {ACCESS_TOKEN}
• x-api-key: {API_KEY}
• x-gw-ims-org-id: {ORG_ID}

Os recursos no Experience Platform podem ser isolados em sandboxes virtuais específicas. Em solicitações para APIs da Platform, é possível especificar o nome e a ID da sandbox em que a operação ocorrerá. Esses parâmetros são opcionais.

• x-sandbox-name: {SANDBOX_NAME}

Todas as solicitações que contêm uma carga (POST, PUT, PATCH) exigem um cabeçalho de tipo de mídia adicional:

• Tipo de conteúdo: application/json

Documentação do Swagger

Você pode encontrar a documentação de referência que acompanha todas as chamadas de API neste tutorial no Swagger. Consulte a Documentação da API do serviço de fluxo no Adobe I/O. Recomendamos que você use este tutorial e a página de documentação do Swagger em paralelo.

Obter a lista de destinos de streaming disponíveis

Como primeira etapa, você deve decidir para qual destino de streaming ativar os dados. Para começar, execute uma chamada para solicitar uma lista de destinos disponíveis aos quais você pode se conectar e ativar públicos. Execute a seguinte solicitação do GET para o connectionSpecs para retornar uma lista de destinos disponíveis:

Formato da API

GET /connectionSpecs

Solicitação

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

Resposta

Uma resposta bem-sucedida contém uma lista de destinos disponíveis e seus identificadores exclusivos (id). Armazene o valor do destino que você planeja usar, pois ele será necessário em outras etapas. Por exemplo, se você deseja se conectar e entregar públicos-alvo para Amazon Kinesis ou Azure Event Hubs, procure o seguinte trecho na resposta:

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

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

Conectar-se aos dados do Experience Platform

Em seguida, você deve se conectar aos dados do Experience Platform para poder exportar os dados do perfil e ativá-los no destino de sua preferência. Consiste em duas subetapas descritas abaixo.

1. Primeiro, você deve executar uma chamada para autorizar o acesso aos seus dados no Experience Platform, configurando uma conexão base.
2. Em seguida, usando a ID de conexão básica, você fará outra chamada na qual criará uma conexão de origem, que estabelece a conexão com seus dados de Experience Platform.

Autorize o acesso aos seus dados no Experience Platform

Formato da API

POST /connections

Solicitação

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: {ORG_ID}' \
--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}: Use a ID de especificação de conexão para o Serviço de perfil - 8a9c3494-9708-43d7-ae3f-cda01e5030e1.

Resposta

Uma resposta bem-sucedida contém o identificador exclusivo da conexão base (id). Armazene esse valor conforme necessário na próxima etapa para criar a conexão de origem.

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

Conectar-se aos dados do Experience Platform

Formato da API

POST /sourceConnections

Solicitação

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: {ORG_ID}' \
--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}: use a ID que você obteve na etapa anterior.
• {CONNECTION_SPEC_ID}: Use a ID de especificação de conexão para o Serviço de perfil - 8a9c3494-9708-43d7-ae3f-cda01e5030e1.

Resposta

Uma resposta bem-sucedida retorna o identificador exclusivo (id) para a conexão de origem recém-criada ao Serviço de perfil. Isso confirma que você se conectou com êxito aos dados do Experience Platform. Armazene esse valor conforme necessário em uma etapa posterior.

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

Conectar ao destino de streaming

Nesta etapa, você está configurando uma conexão com o destino de transmissão desejado. Consiste em duas subetapas descritas abaixo.

1. Primeiro, você deve executar uma chamada para autorizar o acesso ao destino de streaming, configurando uma conexão base.
2. Em seguida, usando a ID de conexão básica, você fará outra chamada na qual criará uma conexão de destino, que especifica o local na conta de armazenamento onde os dados exportados serão entregues, bem como o formato dos dados que serão exportados.

Autorizar acesso ao destino de streaming

Formato da API

POST /connections

Solicitação

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: {ORG_ID}' \
--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}: use a ID de especificação de conexão que você obteve na etapa Obter a lista de destinos disponíveis.
• {AUTHENTICATION_CREDENTIALS}: preencha o nome do destino de streaming: Aws Kinesis authentication credentials ou Azure EventHub authentication credentials.
• {ACCESS_ID}: Para Amazon Kinesis conexões. A ID de acesso do local de armazenamento do Amazon Kinesis.
• {SECRET_KEY}: Para Amazon Kinesis conexões. A chave secreta do local de armazenamento do Amazon Kinesis.
• {REGION}: Para Amazon Kinesis conexões. A região em seu Amazon Kinesis conta na qual a Platform transmitirá seus dados.
• {SAS_KEY_NAME}: Para Azure Event Hubs conexões. Preencha o nome da chave SAS. Saiba mais sobre autenticação no Azure Event Hubs com chaves SAS no Documentação do Microsoft.
• {SAS_KEY}: Para Azure Event Hubs conexões. Preencha sua chave SAS. Saiba mais sobre autenticação no Azure Event Hubs com chaves SAS no Documentação do Microsoft.
• {EVENT_HUB_NAMESPACE}: Para Azure Event Hubs conexões. Preencha o Azure Event Hubs namespace em que a Platform transmitirá seus dados. Para obter mais informações, consulte Criar um namespace de Hubs de Eventos no Microsoft documentação.

Resposta

Uma resposta bem-sucedida contém o identificador exclusivo da conexão base (id). Armazene esse valor conforme necessário na próxima etapa para criar uma conexão de destino.

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

Especificar local de armazenamento e formato de dados

Formato da API

POST /targetConnections

Solicitação

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: {ORG_ID}' \
--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}: use a ID de conexão básica que você obteve na etapa acima.
• {CONNECTION_SPEC_ID}: use a especificação de conexão obtida na etapa Obter a lista de destinos disponíveis.
• {NAME_OF_DATA_STREAM}: Para Amazon Kinesis conexões. Forneça o nome do fluxo de dados existente no Amazon Kinesis conta. O Platform exportará dados para esse fluxo.
• {REGION}: Para Amazon Kinesis conexões. A região na sua conta do Amazon Kinesis onde a Platform transmitirá seus dados.
• {EVENT_HUB_NAME}: Para Azure Event Hubs conexões. Preencha o Azure Event Hub nomeie o local em que a Platform transmitirá seus dados. Para obter mais informações, consulte Criar um hub de eventos no Microsoft documentação.

Resposta

Uma resposta bem-sucedida retorna o identificador exclusivo (id) para a conexão de destino recém-criada com o destino de transmissão. Armazene esse valor conforme necessário nas etapas posteriores.

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

Criar um fluxo de dados

Usando as IDs obtidas nas etapas anteriores, agora é possível criar um fluxo de dados entre os dados de Experience Platform e o destino no qual você ativará os dados. Pense nessa etapa como a construção do pipeline, por meio do qual os dados fluirão posteriormente, entre o Experience Platform e o destino desejado.

Para criar um fluxo de dados, execute uma solicitação POST, como mostrado abaixo, enquanto fornece os valores mencionados abaixo na carga.

Execute a seguinte solicitação POST para criar um fluxo de dados.

Formato da API

POST /flows

Solicitação

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: {ORG_ID}' \
-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}: a ID de especificação do fluxo para destinos baseados em perfil é 71471eba-b620-49e4-90fd-23f1fa0174d8. Use esse valor na chamada de.
• {SOURCE_CONNECTION_ID}: use a ID de conexão de origem obtida na etapa Conectar ao Experience Platform.
• {TARGET_CONNECTION_ID}: Use a ID de conexão de destino que você obteve na etapa Conectar ao destino de streaming.

Resposta

Uma resposta bem-sucedida retorna a ID (id) do fluxo de dados recém-criado e uma etag. Anote os dois valores. como você os verá na próxima etapa, para ativar públicos-alvo.

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

Ativar dados para o novo destino

Após criar todas as conexões e o fluxo de dados, agora é possível ativar os dados do perfil para a plataforma de streaming. Nesta etapa, você seleciona quais públicos-alvo e atributos de perfil está enviando para o destino e pode agendar e enviar dados para o destino.

Para ativar públicos para o novo destino, você deve executar uma operação PATCH JSON, semelhante ao exemplo abaixo. Você pode ativar vários públicos-alvo e atributos de perfil em uma chamada. Para saber mais sobre o PATCH JSON, consulte a Especificação RFC.

Formato da API

PATCH /flows

Solicitação

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: {ORG_ID}' \
--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 audience that you are activating",
        "description": "Description of the audience 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}"
      }
    }
  }
]

Resposta

Procure uma resposta 202 OK. Nenhum corpo de resposta é retornado. Para validar se a solicitação estava correta, consulte a próxima etapa, Validar o fluxo de dados.

Validar o fluxo de dados

Como etapa final do tutorial, você deve validar se os públicos-alvo e os atributos de perfil foram realmente mapeados corretamente para o fluxo de dados.

Para validar isso, execute a seguinte solicitação GET:

Formato da API

GET /flows

Solicitação

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: {ORG_ID}' \
--header 'Content-Type: application/json' \
--header 'x-sandbox-name: prod' \
--header 'If-Match: "{ETAG}"'

• {DATAFLOW_ID}: use o fluxo de dados da etapa anterior.
• {ETAG}: use a tag da etapa anterior.

Resposta

A resposta retornada deve incluir na variável transformations defina os parâmetros de públicos-alvo e atributos de perfil enviados na etapa anterior. Uma amostra transformations O parâmetro da resposta do pode ser semelhante ao seguinte:

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

Dados exportados

{
  "person": {
    "email": "yourstruly@adobe.com"
  },
  "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": "realized"
      }
    }
  },
  "identityMap": {
    "ecid": [
      {
        "id": "14575006536349286404619648085736425115"
      },
      {
        "id": "66478888669296734530114754794777368480"
      }
    ],
    "email_lc_sha256": [
      {
        "id": "655332b5fa2aea4498bf7a290cff017cb4"
      },
      {
        "id": "66baf76ef9de8b42df8903f00e0e3dc0b7"
      }
    ]
  }
}

Usar Postman coleções para conectar a destinos de streaming

Para se conectar aos destinos de transmissão descritos neste tutorial de forma mais simples, é possível usar o Postman.

Postman O é uma ferramenta que você pode usar para fazer chamadas de API e gerenciar bibliotecas de chamadas e ambientes predefinidos.

Para este tutorial específico, o seguinte Postman coleções foram anexadas:

• AWS Kinesis Postman coleção
• Azure Event Hubs Postman coleção

Clique em aqui para baixar o arquivo de coleções.

Cada coleção inclui as solicitações e as variáveis de ambiente necessárias para AWS Kinesis, e Azure Event Hub, respectivamente.

Como usar o Postman coleções

Para se conectar com sucesso aos destinos usando o Postman coleções, siga estas etapas:

• Baixar e instalar Postman;
• Baixar e descompacte as coleções anexadas;
• Importar as coleções das pastas correspondentes para o Postman;
• Preencha as variáveis de ambiente de acordo com as instruções neste artigo;
• Execute o API solicitações de Postman, com base nas instruções deste artigo.

Manipulação de erros de API

Os endpoints de API neste tutorial seguem os princípios gerais de mensagem de erro da API Experience Platform. Consulte Códigos de status da API e erros no cabeçalho da solicitação no guia de solução de problemas da Platform para obter mais informações sobre como interpretar respostas de erro.

Próximas etapas

Ao seguir este tutorial, você conectou com sucesso o Platform a um dos seus destinos de transmissão preferidos e configurou um fluxo de dados para o respectivo destino. Os dados de saída agora podem ser usados no destino para análises de clientes ou quaisquer outras operações de dados que você deseje executar. Consulte as seguintes páginas para obter mais detalhes:

• Visão geral dos destinos
• Visão geral do Catálogo de destinos