Créez une connexion source Azure Event Hubs à l’aide de l’API Flow Service

Ce tutoriel vous guide tout au long des étapes permettant de connecter Azure Event Hubs (ci-après appelé "Event Hubs") à l’Experience Platform à l’aide de l’Flow Service API.

Prise en main

Ce guide nécessite une compréhension professionnelle des composants suivants d’Adobe Experience Platform :

  • Sources : Experience Platform permet d’ingérer des données provenant de diverses sources tout en vous permettant de structurer, d’étiqueter et d’améliorer les données entrantes à l’aide de Platform services.
  • Environnements de test : Experience Platform fournit des environnements de test virtuels qui divisent une instance Platform unique en environnements virtuels distincts pour favoriser le développement et l’évolution d’applications d’expérience numérique.

Les sections suivantes apportent des informations supplémentaires dont vous aurez besoin pour connecter Event Hubs à Platform à l’aide de l’API Flow Service.

Collecte des informations d’identification requises

Pour que Flow Service se connecte à votre compte Event Hubs, vous devez fournir des valeurs pour les propriétés de connexion suivantes :

Credential Description
sasKeyName Nom de la règle d’autorisation, également connu sous le nom de clé SAS.
sasKey Signature d’accès partagé générée.
namespace L’espace de noms du Event Hubs auquel vous accédez. Un espace de noms Event Hubs fournit un conteneur d’étendue unique, dans lequel vous pouvez créer un ou plusieurs Event Hubs.
connectionSpec.id La spécification de connexion renvoie les propriétés du connecteur d’une source, y compris les spécifications d’authentification liées à la création des connexions base et source. L’identifiant de spécification de connexion Event Hubs est : bf9f5905-92b7-48bf-bf20-455bc6b60a4e.

Pour plus d’informations sur ces valeurs, reportez-vous à ce document Event Hubs.

Utilisation des API Platform

Pour plus d’informations sur la manière d’effectuer des appels avec succès vers les API Platform, consultez le guide de prise en main des API Platform.

Création d’une connexion de base

La première étape de la création d’une connexion source consiste à authentifier votre source Event Hubs et à générer un identifiant de connexion de base. Un identifiant de connexion de base vous permet d’explorer et de parcourir les fichiers de votre source et d’identifier les éléments spécifiques à ingérer, y compris des informations concernant leurs types et formats de données.

Pour créer un identifiant de connexion de base, envoyez une requête de POST au point de terminaison /connections tout en fournissant vos informations d’authentification Event Hubs dans le cadre des paramètres de requête.

Format d’API

POST /connections

Requête

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"
        }
    }'
Propriété Description
auth.params.sasKeyName Nom de la règle d’autorisation, également connu sous le nom de clé SAS.
auth.params.sasKey Signature d’accès partagé générée.
auth.params.namespace L’espace de noms du Event Hubs auquel vous accédez.
connectionSpec.id L’identifiant de spécification de connexion Event Hubs est : bf9f5905-92b7-48bf-bf20-455bc6b60a4e

Réponse

Une réponse réussie renvoie les détails de la connexion de base que vous venez de créer, y compris son identifiant unique (id). Cet identifiant de connexion est requis à l’étape suivante pour créer une connexion source.

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

Création d’une connexion source

Une connexion source crée et gère la connexion à la source externe à partir de laquelle les données sont ingérées. Une connexion source se compose d’informations telles que la source de données, le format de données et un identifiant de connexion source nécessaires à la création d’un flux de données. Une instance de connexion source est spécifique à un client et à une organisation IMS.

Pour créer une connexion source, envoyez une requête de POST au point de terminaison /sourceConnections de l’API Flow Service.

Format d’API

POST /sourceConnections

Requête

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}"
        }
    }'
Propriété Description
name Nom de la connexion source. Assurez-vous que le nom de votre connexion source est descriptif, car vous pouvez l’utiliser pour rechercher des informations sur votre connexion source.
description Valeur facultative que vous pouvez fournir pour inclure plus d’informations sur votre connexion source.
baseConnectionId Identifiant de connexion de la source Event Hubs qui a été généré à l’étape précédente.
connectionSpec.id L’identifiant de spécification de connexion fixe pour Event Hubs. Cet identifiant est : bf9f5905-92b7-48bf-bf20-455bc6b60a4e.
data.format Format des données Event Hubs que vous souhaitez ingérer. Actuellement, le seul format de données pris en charge est json.
params.eventHubName Nom de la source Event Hubs.
params.dataType Ce paramètre définit le type des données ingérées. Les types de données pris en charge sont les suivants : raw et xdm.
params.reset Ce paramètre définit la manière dont les données seront lues. Utilisez latest pour commencer la lecture à partir des données les plus récentes et utilisez earliest pour commencer la lecture à partir des premières données disponibles dans le flux. Ce paramètre est facultatif et prend par défaut la valeur earliest s’il n’est pas fourni.
params.consumerGroup Le mécanisme de publication ou d’abonnement à utiliser pour Event Hubs. Ce paramètre est facultatif et prend par défaut la valeur $Default s’il n’est pas fourni. Pour plus d’informations, consultez ce Event Hubs guide sur les consommateurs d’événements .

Étapes suivantes

En suivant ce tutoriel, vous avez créé une connexion source Event Hubs à l’aide de l’API Flow Service. Vous pouvez utiliser cet identifiant de connexion source dans le tutoriel suivant pour créer un flux de données en continu à l’aide de l’ Flow Service API.

Sur cette page