DocumentaciónExperience PlatformGuía de conectores de origen

Crear un Phoenix conexión base mediante el Flow Service API

Last update: Mon Nov 13 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Creado para:

  • Desarrollador

Una conexión base representa la conexión autenticada entre un origen y Adobe Experience Platform.

Este tutorial proporciona pasos sobre cómo crear una conexión base y conectar su Phoenix a Adobe Experience Platform mediante el Flow Service API.

Introducción

Esta guía requiere una comprensión práctica de los siguientes componentes de Experience Platform:

  • Fuentes: Experience Platform permite la ingesta de datos desde varias fuentes, al tiempo que le ofrece la capacidad de estructurar, etiquetar y mejorar los datos entrantes mediante los servicios de Experience Platform.
  • Zonas protegidas: Experience Platform proporciona entornos limitados virtuales que dividen una sola instancia de Experience Platform en entornos virtuales independientes para ayudar a desarrollar y evolucionar aplicaciones de experiencia digital.

Las secciones siguientes proporcionan información adicional que deberá conocer para conectarse correctamente a Phoenix uso del Flow Service API.

Recopilar credenciales necesarias

Debe proporcionar las siguientes credenciales de autenticación para conectar su Phoenix cuenta para el Experience Platform.

Credencial
Descripción
host
La dirección IP o el nombre de host del Phoenix servidor.
username
El nombre de usuario que utiliza para acceder a Phoenix Servidor.
password
La contraseña correspondiente al usuario.
port
El puerto TCP en el que Phoenix El servidor de utiliza para detectar conexiones de cliente. Si se conecta a Azure HDInsights, luego especifique el puerto como 443. Si no se proporciona este parámetro, el valor predeterminado es 8765.
httpPath
La URL parcial correspondiente a Phoenix servidor. Especifique /hbasephoenix0 si utiliza Azure Clúster de HDInsights.
enableSsl
Un valor booleano. Especifica si las conexiones al servidor se cifran con SSL.
connectionSpec.id
La especificación de conexión devuelve las propiedades del conector de origen, incluidas las especificaciones de autenticación relacionadas con la creación de las conexiones base y origen. Identificador de especificación de conexión para Phoenix es: 102706fb-a5cd-42ee-afe0-bc42f017ff43

Para obtener más información sobre cómo empezar, consulte este documento de Phoenix.

Uso de API de Platform

Para obtener información sobre cómo realizar llamadas correctamente a las API de Platform, consulte la guía de introducción a las API de Platform.

Cree una conexión base

Una conexión base retiene información entre el origen y Platform, incluidas las credenciales de autenticación del origen, el estado actual de la conexión y el ID único de conexión base. El ID de conexión base le permite explorar y navegar por archivos desde el origen e identificar los elementos específicos que desea introducir, incluida la información sobre sus tipos de datos y formatos.

Para crear una conexión base, realice una solicitud de POST al /connections extremo al proporcionar su Phoenix credenciales de autenticación en el cuerpo de la solicitud.

Formato de API

POST /connections

Solicitud

La siguiente solicitud crea una conexión 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"
      }
  }'
Propiedad
Descripción
auth.params.host
El host del Phoenix servidor.
auth.params.username
El nombre de usuario asociado con su Phoenix conexión.
auth.params.password
La contraseña asociada a su Phoenix conexión.
auth.params.port
El puerto TCP para su Phoenix conexión.
auth.params.httpPath
La ruta http parcial para su Phoenix conexión.
auth.params.enableSsl
Valor booleano que especifica si las conexiones con el servidor se cifran mediante SSL.
connectionSpec.id
El Phoenix identificador de especificación de conexión: 102706fb-a5cd-42ee-afe0-bc42f017ff43.

Respuesta

Una respuesta correcta devuelve detalles de la conexión recién creada, incluido su identificador único (id). Este ID es necesario para explorar los datos en el siguiente tutorial.

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

Pasos siguientes

Al seguir este tutorial, ha creado un Phoenix conexión base mediante el Flow Service API. Puede utilizar este ID de conexión base en los siguientes tutoriales:

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