Créez une connexion source Microsoft Dynamics à l’aide de l’API Flow Service.

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 Flow Service pour vous guider à travers les étapes de connexion de la plate-forme à un compte Microsoft Dynamics (ci-après appelé "Dynamics") à l'aide de l'API de service de flux.

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 des services de plate-forme.
  • Environnements de test : Experience Platform fournit des environnements de test virtuels qui divisent une instance de plateforme unique en environnements virtuels distincts pour favoriser le développement et l’évolution d’applications d’expérience numérique.

Les sections suivantes fournissent des informations supplémentaires dont vous aurez besoin pour connecter la plateforme à un compte Dynamics à l'aide de l'API Flow Service.

Collecte des informations d’identification requises

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

Informations d’identification Description
serviceUri URL de service de votre instance Dynamics.
username Nom d’utilisateur de votre compte d’utilisateur Dynamics.
password Mot de passe de votre compte Dynamics.
servicePrincipalId ID client de votre compte Dynamics. Cet identifiant est requis lors de l’utilisation de l’authentification principale et de l’authentification par clé.
servicePrincipalKey Clé secrète principale du service. Ces informations d’identification sont requises lors de l’utilisation de l’authentification principale de service et de l’authentification par clé.

Pour plus d'informations sur la prise en main, consultez ce Dynamics document.

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. Pour plus d’informations sur les conventions utilisées dans la documentation pour les exemples d’appels API, consultez la section sur la lecture d’exemples d’appels API dans le guide de dépannage d’Experience Platform.

Collecte des valeurs des en-têtes requis

Pour lancer des appels aux API Platform, vous devez d’abord suivre le tutoriel sur l’authentification. Le tutoriel sur l’authentification indique les valeurs de chacun des en-têtes requis dans tous les appels API Experience Platform, comme illustré ci-dessous :

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Toutes les ressources en Experience Platform, y compris celles appartenant à Flow Service, sont isolées dans des sandbox virtuels spécifiques. Toutes les requêtes envoyées aux API Platform nécessitent un en-tête spécifiant le nom de l’environnement de test dans lequel l’opération sera effectuée :

  • 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 compte Dynamics, car elle peut être utilisée pour créer plusieurs flux de données afin d’importer des données différentes.

Créer une connexion Dynamics à l'aide de l'authentification de base

Pour créer une connexion Dynamics à l'aide de l'authentification de base, faites une demande de POST à l'API Flow Service tout en fournissant des valeurs pour serviceUri, username et password de votre connexion.

Format d’API

POST /connections

Requête

Pour créer une connexion Dynamics, l'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 Dynamics est 38ad80fe-8b06-4938-94f4-d4ee80266b07.

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": "Dynamics connection",
        "description": "Dynamics connection using basic auth",
        "auth": {
            "specName": "Basic Authentication for Dynamics-Online",
            "params": {
                "serviceUri": "{SERVICE_URI}",
                "username": "{USERNAME}",
                "password": "{PASSWORD}"
            }
        },
        "connectionSpec": {
            "id": "38ad80fe-8b06-4938-94f4-d4ee80266b07",
            "version": "1.0"
        }
    }'
Propriété Description
auth.params.serviceUri URI de service associé à votre instance Dynamics.
auth.params.username Nom d'utilisateur associé à votre compte Dynamics.
auth.params.password Mot de passe associé à votre compte Dynamics.
connectionSpec.id Spécification de connexion id de votre compte Dynamics récupérée à l'étape précédente.

Réponse

Une réponse réussie renvoie la connexion nouvellement créée, y compris son identifiant unique (id). Cet identifiant est nécessaire pour explorer votre système de gestion de la relation client à l’étape suivante.

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"9e0052a2-0000-0200-0000-5e35tb330000\""
}

Créer une connexion Dynamics à l'aide de l'authentification par clé principale de service

Pour créer une connexion Dynamics à l'aide de l'authentification par clé principale de service, faites une demande de POST à l'API Flow Service tout en fournissant des valeurs pour serviceUri, servicePrincipalId et servicePrincipalKey de votre connexion.

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": "Dynamics connection",
        "description": "Dynamics connection using key-based authentication",
        "auth": {
            "specName": "Service Principal Key Based Authentication",
            "params": {
                "serviceUri": "{SERVICE_URI}",
                "servicePrincipalId": "{SERVICE_PRINCIPAL_ID}",
                "servicePrincipalKey": "{SERVICE_PRINCIPAL_KEY}"
            }
        },
        "connectionSpec": {
            "id": "38ad80fe-8b06-4938-94f4-d4ee80266b07",
            "version": "1.0"
        }
    }'
Propriété Description
auth.params.serviceUri URI de service associé à votre instance Dynamics.
auth.params.servicePrincipalId ID client de votre compte Dynamics. Cet identifiant est requis lors de l’utilisation de l’authentification principale et de l’authentification par clé.
auth.params.servicePrincipalKey Clé secrète principale du service. Ces informations d’identification sont requises lors de l’utilisation de l’authentification principale de service et de l’authentification par clé.

Réponse

Une réponse réussie renvoie la connexion nouvellement créée, y compris son identifiant unique (id). Cet identifiant est nécessaire pour explorer votre système de gestion de la relation client à l’étape suivante.

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"9e0052a2-0000-0200-0000-5e35tb330000\""
}

Étapes suivantes

En suivant ce didacticiel, vous avez créé une connexion Dynamics à l'aide de l'API Flow Service et obtenu la valeur d'ID unique de la connexion. Vous pouvez utiliser cet identifiant dans le didacticiel suivant lorsque vous apprendrez à explorer les systèmes de gestion de la relation client à l’aide de l’API Flow Service.

Sur cette page