Show Menu
SUJETS×

Création d’un Azure Synapse Analytics connecteur à l’aide de l’ Flow Service API

Le connecteur Azure Synapse Analytics est en version bêta. Pour plus d’informations sur l’utilisation de connecteurs bêta, consultez l’aperçu des sources.
Flow Service est utilisée pour collecter et centraliser les données client provenant de diverses sources disparates à 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 dans les étapes à suivre pour vous connecter Azure Synapse Analytics (ci-après appelé "Synapse") à Experience Platform.

Prise en main

Ce guide nécessite une compréhension professionnelle des composants suivants d’Adobe Experience Platform :
  • Sources : Experience Platform permet l’assimilation de données à partir de diverses sources tout en vous permettant de structurer, d’étiqueter et d’améliorer les données entrantes à l’aide de Platform services.
  • Sandbox : Experience Platform fournit des sandbox virtuels qui partitionnent une Platform instance unique en environnements virtuels distincts pour aider à développer et développer des applications d'expérience numérique.
The following sections provide additional information that you will need to know in order to successfully connect to Synapse using the Flow Service API.

Collecte des informations d’identification requises

Pour Flow Service établir une connexion avec Synapse, vous devez fournir des valeurs pour les propriétés de connexion suivantes :
Informations d’identification
Description
connectionString
Chaîne de connexion utilisée pour la connexion à Synapse. Le modèle Synapse de chaîne de connexion est Server=tcp:{SERVER_NAME}.database.windows.net,1433;Database={DATABASE};User ID={USERNAME}@{SERVER_NAME};Password={PASSWORD};Trusted_Connection=False;Encrypt=True;Connection Timeout=30 le suivant.
connectionSpec.id
Identificateur unique nécessaire pour créer une connexion. L'ID de spécification de connexion pour Synapse est : a49bcc7d-8038-43af-b1e4-5a7a089a7d79
Pour plus d'informations sur l'obtention d'une chaîne de connexion, reportez-vous à ce document Synapse.

Lecture d’exemples d’appels API

Ce tutoriel fournit des exemples d’appels API pour démontrer comment formater vos requêtes. Il s’agit notamment de chemins d’accès, d’en-têtes requis et de payloads de requêtes correctement formatés. L’exemple JSON renvoyé dans les réponses de l’API est également fourni. For information on the conventions used in documentation for sample API calls, see the section on how to read example API calls in the Experience Platform troubleshooting guide.

Collecte des valeurs des en-têtes requis

In order to make calls to Platform APIs, you must first complete the authentication tutorial . Completing the authentication tutorial provides the values for each of the required headers in all Experience Platform API calls, as shown below:
  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
All resources in Experience Platform, including those belonging to the Flow Service, are isolated to specific virtual sandboxes. All requests to Platform APIs require a header that specifies the name of the sandbox the operation will take place in:
  • x-sandbox-name: {SANDBOX_NAME}
Toutes les requêtes qui contiennent un payload (POST, PUT, PATCH) nécessitent un en-tête de type de média 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. Une seule connexion est requise par Synapse compte, car elle peut être utilisée pour créer plusieurs connecteurs source pour importer des données différentes.
Format d’API
POST /connections

Requête
Pour créer une Synapse connexion, son identifiant de spécification de connexion unique doit être fourni dans le cadre de la demande du POST. L'ID de spécification de connexion pour Synapse est a49bcc7d-8038-43af-b1e4-5a7a089a7d79 .
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": "Connection for Azure Synapse Analytics",
        "description": "Connection for Azure Synapse Analytics",
        "auth": {
            "specName": "Connection String Based Authentication",
            "params": {
                "connectionString": "Server=tcp:{SERVER_NAME}.database.windows.net,1433;Database={DATABASE};User ID={USERNAME}@{SERVER_NAME};Password={PASSWORD};Trusted_Connection=False;Encrypt=True;Connection Timeout=30"
            }
        },
        "connectionSpec": {
            "id": "a49bcc7d-8038-43af-b1e4-5a7a089a7d79",
            "version": "1.0"
        }
    }'

Paramètre
Description
auth.params.connectionString
Chaîne de connexion utilisée pour la connexion à Synapse. Le modèle Synapse de chaîne de connexion est Server=tcp:{SERVER_NAME}.database.windows.net,1433;Database={DATABASE};User ID={USERNAME}@{SERVER_NAME};Password={PASSWORD};Trusted_Connection=False;Encrypt=True;Connection Timeout=30 le suivant.
connectionSpec.id
L'ID de spécification de Synapse connexion est : a49bcc7d-8038-43af-b1e4-5a7a089a7d79 .
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 votre base de données dans le didacticiel suivant.
{
    "id": "6bc13a3b-3546-455f-813a-3b3546a55fb1",
    "etag": "\"3500866c-0000-0200-0000-5e83afa30000\""
}

Étapes suivantes

En suivant ce didacticiel, vous avez créé une Synapse connexion à l’aide de l’ Flow Service API 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.