DocumentaçãoExperience PlatformGuia dos conectores de origem

Criar uma conexão de base Phoenix usando a API Flow Service

Last update: Wed Nov 27 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • Desenvolvedor
WARNING
A origem Phoenix será substituída no final de junho de 2025.

Uma conexão base representa a conexão autenticada entre uma origem e o Adobe Experience Platform.

Este tutorial fornece etapas sobre como criar uma conexão básica e conectar sua conta do Phoenix ao Adobe Experience Platform usando a API do Flow Service.

Introdução

Este guia requer entendimento prático dos seguintes componentes do Experience Platform:

  • Fontes: o Experience Platform permite a assimilação de dados de várias fontes, além de fornecer a capacidade de estruturar, rotular e aprimorar os dados recebidos usando os serviços Experience Platform.
  • Sandboxes: o Experience Platform fornece sandboxes virtuais que particionam uma única instância de Experience 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 se conectar com êxito ao Phoenix usando a API Flow Service.

Coletar credenciais necessárias

Você deve fornecer as seguintes credenciais de autenticação para conectar sua conta do Phoenix ao Experience Platform.

Credencial
Descrição
host
O endereço IP ou o nome de host do servidor Phoenix.
username
O nome de usuário que você usa para acessar o Servidor Phoenix.
password
A senha correspondente ao usuário.
port
A porta TCP que o servidor Phoenix usa para escutar conexões de clientes. Se você estiver se conectando a Azure HDInsights, especifique a porta como 443. Se esse parâmetro não for fornecido, o valor padrão será 8765.
httpPath
A URL parcial correspondente ao servidor Phoenix. Especifique /hbasephoenix0 se estiver usando o cluster HDInsights Azure.
enableSsl
Um valor booleano. Especifica se as conexões com o servidor são criptografadas usando SSL.
connectionSpec.id
A especificação de conexão retorna as propriedades do conector de uma origem, incluindo especificações de autenticação relacionadas à criação das conexões de base e de origem. A ID da especificação de conexão para Phoenix é: 102706fb-a5cd-42ee-afe0-bc42f017ff43

Para obter mais informações sobre a introdução, consulte este documento do Phoenix.

Uso de APIs da plataforma

Para obter informações sobre como fazer chamadas para APIs da Platform com êxito, consulte o manual sobre introdução às APIs da Platform.

Criar uma conexão básica

Uma conexão base retém informações entre sua origem e a Platform, incluindo as credenciais de autenticação da origem, o estado atual da conexão e sua ID de conexão base exclusiva. A ID de conexão básica permite explorar e navegar pelos arquivos de dentro da origem e identificar os itens específicos que deseja assimilar, incluindo informações sobre os tipos de dados e formatos.

Para criar uma conexão base, faça uma solicitação POST para o ponto de extremidade /connections ao fornecer suas credenciais de autenticação Phoenix no corpo da solicitação.

Formato da API

POST /connections

Solicitação

A solicitação a seguir cria uma conexão base para Phoenix:

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/connections' \
  -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": "Phoenix test connection",
      "description": "Phoenix test connection",
      "auth": {
          "specName": "Basic Authentication",
      "params": {
          "host":  "{HOST}",
          "username": "{USERNAME}",
          "password":"{PASSWORD}",
          "port": {PORT},
          "httpPath": "{PATH}",
          "enableSsl": {SSL}
          }
      },
      "connectionSpec": {
          "id": "102706fb-a5cd-42ee-afe0-bc42f017ff43",
          "version": "1.0"
      }
  }'
Propriedade
Descrição
auth.params.host
O host do servidor Phoenix.
auth.params.username
O nome de usuário associado à sua conexão Phoenix.
auth.params.password
A senha associada à sua conexão Phoenix.
auth.params.port
A porta TCP da conexão Phoenix.
auth.params.httpPath
O caminho http parcial para sua conexão Phoenix.
auth.params.enableSsl
O valor booleano que especifica se as conexões com o servidor são criptografadas usando SSL.
connectionSpec.id
A ID da especificação de conexão Phoenix: 102706fb-a5cd-42ee-afe0-bc42f017ff43.

Resposta

Uma resposta bem-sucedida retorna detalhes da conexão recém-criada, incluindo seu identificador exclusivo (id). Essa ID é necessária para explorar seus dados no próximo tutorial.

{
    "id": "0d982fff-c443-403e-982f-ffc443f03e37",
    "etag": "\"830082dc-0000-0200-0000-5e84ee560000\""
}

Próximas etapas

Seguindo este tutorial, você criou uma conexão de base Phoenix usando a API Flow Service. Você pode usar essa ID de conexão básica nos seguintes tutoriais:

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089