Crear una conexión de origen Azure Event Hubs mediante la API Flow Service

Este tutorial le guía por los pasos para conectar Azure Event Hubs (en adelante denominado "Event Hubs") con el Experience Platform, utilizando la Flow Service API.

Primeros pasos

Esta guía requiere conocer los siguientes componentes de Adobe Experience Platform:

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

Las secciones siguientes proporcionan información adicional que deberá conocer para conectar correctamente Event Hubs a Platform mediante la API Flow Service.

Recopilar las credenciales necesarias

Para que Flow Service se conecte con su cuenta Event Hubs, debe proporcionar valores para las siguientes propiedades de conexión:

Credencial Descripción
sasKeyName El nombre de la regla de autorización, que también se conoce como nombre de clave SAS.
sasKey La firma de acceso compartido generada.
namespace El espacio de nombres del Event Hubs al que está accediendo. Un espacio de nombres Event Hubs proporciona un contenedor de ámbitos único, en el que puede crear uno o más Event Hubs.
connectionSpec.id La especificación de conexión devuelve las propiedades del conector de un origen, incluidas las especificaciones de autenticación relacionadas con la creación de las conexiones base y de origen. El ID de especificación de conexión Event Hubs es: bf9f5905-92b7-48bf-bf20-455bc6b60a4e.

Para obtener más información sobre estos valores, consulte este documento de centros de eventos.

Uso de las API de plataforma

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.

Creación de una conexión base

El primer paso para crear una conexión de origen es autenticar el origen Event Hubs y generar un ID de conexión base. Un ID de conexión base le permite explorar y navegar por archivos desde el origen e identificar elementos específicos que desee introducir, incluida información sobre sus tipos de datos y formatos.

Para crear un ID de conexión base, realice una solicitud de POST al extremo /connections y proporcione las credenciales de autenticación Event Hubs como parte de los parámetros de solicitud.

Formato de API

POST /connections

Solicitud

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: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'Content-Type: application/json' \
    -d '{
        "name": "Azure Event Hubs connection",
        "description": "Connector for Azure Event Hubs",
        "auth": {
            "specName": "Azure EventHub authentication credentials",
            "params": {
                "sasKeyName": "{SAS_KEY_NAME}",
                "sasKey": "{SAS_KEY}",
                "namespace": "{NAMESPACE}"
            }
        },
        "connectionSpec": {
            "id": "bf9f5905-92b7-48bf-bf20-455bc6b60a4e",
            "version": "1.0"
        }
    }'
Propiedad Descripción
auth.params.sasKeyName El nombre de la regla de autorización, que también se conoce como nombre de clave SAS.
auth.params.sasKey La firma de acceso compartido generada.
auth.params.namespace El espacio de nombres del Event Hubs al que está accediendo.
connectionSpec.id El ID de especificación de conexión Event Hubs es: bf9f5905-92b7-48bf-bf20-455bc6b60a4e

Respuesta

Una respuesta correcta devuelve detalles de la conexión base recién creada, incluido su identificador único (id). Este ID de conexión es necesario en el paso siguiente para crear una conexión de origen.

{
    "id": "4cdbb15c-fb1e-46ee-8049-0f55b53378fe",
    "etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}

Crear una conexión de origen

Una conexión de origen crea y administra la conexión con el origen externo desde el que se introducen los datos. Una conexión de origen consiste en información como el origen de datos, el formato de datos y un ID de conexión de origen necesario para crear un flujo de datos. Una instancia de conexión de origen es específica para un inquilino y una organización IMS.

Para crear una conexión de origen, realice una solicitud de POST al extremo /sourceConnections de la API Flow Service.

Formato de API

POST /sourceConnections

Solicitud

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
    -H 'authorization: Bearer {ACCESS_TOKEN}' \
    -H 'content-type: application/json' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {IMS_Org}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -d '{
        "name": "Azure Event Hubs source connection",
        "description": "A source connection for Azure Event Hubs",
        "baseConnectionId": "4cdbb15c-fb1e-46ee-8049-0f55b53378fe",
        "connectionSpec": {
            "id": "bf9f5905-92b7-48bf-bf20-455bc6b60a4e",
            "version": "1.0"
        },
        "data": {
            "format": "json"
        },
        "params": {
            "eventHubName": "{EVENTHUB_NAME}",
            "dataType": "raw",
            "reset": "latest",
            "consumerGroup": "{CONSUMER_GROUP}"
        }
    }'
Propiedad Descripción
name Nombre de la conexión de origen. Asegúrese de que el nombre de la conexión de origen sea descriptivo, ya que puede utilizarlo para buscar información sobre la conexión de origen.
description Un valor opcional que puede proporcionar para incluir más información sobre la conexión de origen.
baseConnectionId El ID de conexión de su origen Event Hubs que se generó en el paso anterior.
connectionSpec.id El ID de especificación de conexión fija para Event Hubs. Este ID es : bf9f5905-92b7-48bf-bf20-455bc6b60a4e.
data.format El formato de los datos Event Hubs que desea introducir. Actualmente, el único formato de datos admitido es json.
params.eventHubName El nombre del origen Event Hubs.
params.dataType Este parámetro define el tipo de datos que se están incorporando. Los tipos de datos admitidos son: raw y xdm.
params.reset Este parámetro define cómo se leerán los datos. Utilice latest para empezar a leer los datos más recientes y utilice earliest para comenzar a leer los primeros datos disponibles del flujo. Este parámetro es opcional y su valor predeterminado es earliest si no se proporciona.
params.consumerGroup El mecanismo de publicación o suscripción que se utilizará para Event Hubs. Este parámetro es opcional y su valor predeterminado es $Default si no se proporciona. Consulte esta Event Hubs guía sobre consumidores de eventos para obtener más información.

Pasos siguientes

Siguiendo este tutorial, ha creado una conexión de origen Event Hubs utilizando la API Flow Service. Puede utilizar este ID de conexión de origen en el siguiente tutorial para crear un flujo de datos de flujo continuo mediante la Flow Service API.

En esta página