Show Menu
SUJETS×

Création d'un connecteur Azure Data Explorer à l'aide de l'API Flow Service

Le connecteur Azure Data Explorer est en version bêta. Les fonctionnalités et la documentation peuvent être modifiées.
Le service de flux permet de collecter et de centraliser les données client à partir de diverses sources disparates dans Adobe Experience Platform. Le service fournit une interface utilisateur et une API RESTful à partir de laquelle toutes les sources prises en charge sont connectables.
Ce didacticiel utilise l'API du service de flux pour vous guider à travers les étapes nécessaires à la connexion d'Azure Data Explorer (ci-après appelé "Data Explorer") à la plateforme d'expérience.

Prise en main

Ce guide nécessite une bonne compréhension des composants suivants d’Adobe Experience Platform :
  • Sources : Experience Platform permet d’importer des données à partir de diverses sources tout en vous permettant de structurer, d’étiqueter et d’améliorer les données entrantes à l’aide des services de la plate-forme.
  • Sandbox : Experience Platform fournit des sandbox virtuels qui partitionnent une instance de plateforme unique en environnements virtuels distincts pour aider à développer et à développer des applications d’expérience numérique.
Les sections suivantes contiennent des informations supplémentaires dont vous aurez besoin pour vous connecter à Data Explorer à l’aide de l’API de service de flux.

Collecte des informations d’identification requises

Pour que le service de flux se connecte à l’Explorateur de données, vous devez fournir des valeurs pour les propriétés de connexion suivantes :
Informations d’identification
Description
endpoint
Point de terminaison du serveur Data Explorer.
database
Nom de la base de données de l’Explorateur de données.
tenant
ID de client unique utilisé pour la connexion à la base de données de l’Explorateur de données.
servicePrincipalId
ID principal de service unique utilisé pour la connexion à la base de données de l’Explorateur de données.
servicePrincipalKey
Clé principale de service unique utilisée pour la connexion à la base de données de l’Explorateur de données.
connectionSpec.id
Identificateur unique nécessaire pour créer une connexion. L'ID de spécification de connexion de l'Explorateur de données est 0479cc14-7651-4354-b233-7480606c2ac3 défini.
Pour plus d'informations sur la prise en main, consultez ce document de l'Explorateur de données.

Lecture des exemples d’appels d’API

Ce didacticiel fournit des exemples d’appels d’API pour montrer comment formater vos requêtes. Il s’agit notamment des chemins d’accès, des en-têtes requis et des charges de requête correctement formatées. L’exemple JSON renvoyé dans les réponses de l’API est également fourni. Pour plus d’informations sur les conventions utilisées dans la documentation pour les exemples d’appels d’API, voir la section sur comment lire des exemples d’appels d’API dans le guide de dépannage d’Experience Platform.

Rassembler les valeurs des en-têtes requis

Pour lancer des appels aux API de plateforme, vous devez d’abord suivre le didacticiel d’ authentification. Le didacticiel d’authentification fournit les valeurs de chacun des en-têtes requis dans tous les appels d’API de plateforme d’expérience, comme indiqué ci-dessous :
  • Autorisation : Porteur {ACCESS_TOKEN}
  • x-api-key : {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Toutes les ressources de la plate-forme d’expérience, y compris celles appartenant au service de flux, sont isolées dans des sandbox virtuels spécifiques. Toutes les requêtes d’API de plateforme nécessitent un en-tête spécifiant le nom du sandbox dans lequel l’opération aura lieu :
  • x-sandbox-name : {SANDBOX_NAME}
Toutes les requêtes qui contiennent une charge utile (POST, PUT, PATCH) nécessitent un en-tête de type de support supplémentaire :
  • Content-Type : application/json

Création d’une connexion

Une connexion spécifie une source et contient vos informations d’identification pour cette source. Un seul connecteur est requis par compte Data Explorer, car il peut être utilisé pour créer plusieurs connecteurs source pour importer des données différentes.
Format d’API
POST /connections

Requête
Pour créer une connexion à l’Explorateur de données, l’identifiant de spécification de connexion unique doit être fourni dans le cadre de la demande POST. L'ID de spécification de connexion de l'Explorateur de données est 0479cc14-7651-4354-b233-7480606c2ac3 défini.
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 Data Explorer connection",
        "description": "A connection for Azure Data Explorer",
        "auth": {
            "specName": "Service Principal Based Authentication",
            "params": {
                    "endpoint": "{ENDPOINT}",
                    "database": "{DATABASE}",
                    "tenant": "{TENANT}",
                    "servicePrincipalId": "{SERVICE_PRINCIPAL_ID}",
                    "servicePrincipalKey": "{SERVICE_PRINCIPAL_KEY}"
                }
        },
        "connectionSpec": {
            "id": "0479cc14-7651-4354-b233-7480606c2ac3",
            "version": "1.0"
        }
    }'

Paramètre
Description
auth.params.endpoint
Point de terminaison du serveur Data Explorer.
auth.params.database
Nom de la base de données de l’Explorateur de données.
auth.params.tenant
ID de client unique utilisé pour la connexion à la base de données de l’Explorateur de données.
auth.params.servicePrincipalId
ID principal de service unique utilisé pour la connexion à la base de données de l’Explorateur de données.
auth.params.servicePrincipalKey
Clé principale de service unique utilisée pour la connexion à la base de données de l’Explorateur de données.
connectionSpec.id
ID de la spécification de connexion de l'explorateur de données : 0479cc14-7651-4354-b233-7480606c2ac3 .
Réponse
Une réponse réussie renvoie les détails de la connexion nouvellement créée, y compris son identifiant unique ( id ). Cet identifiant est nécessaire pour explorer vos données dans le didacticiel suivant.
{
    "id": "f088e4f2-2464-480c-88e4-f22464b80c90",
    "etag": "\"43011faa-0000-0200-0000-5ea740cd0000\""
}

Étapes suivantes

En suivant ce didacticiel, vous avez créé une connexion à l’Explorateur de données à l’aide de l’API du service de flux et obtenu la valeur d’ID unique de la connexion. Vous pouvez utiliser cet identifiant dans le didacticiel suivant lorsque vous apprendrez à explorer des bases de données à l’aide de l’API Flow Service.