Show Menu
SUJETS×

Explorez un système de gestion de la relation client à l’aide de l’ Flow Service API

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’ Flow Service API pour explorer les systèmes de gestion de la relation client.

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 a CRM system using the Flow Service API.

Obtention d’une connexion de base

Pour explorer votre système de gestion de la relation client à l’aide Platform d’API, vous devez posséder un ID de connexion de base valide. Si vous ne disposez pas déjà d’une connexion de base pour le système de gestion de la relation client que vous souhaitez utiliser, vous pouvez en créer une à l’aide des didacticiels suivants :

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 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

Explorez vos tableaux de données

La connexion de base de votre système de gestion de la relation client vous permet d’explorer vos tableaux de données en exécutant des requêtes de GET. Utilisez l'appel suivant pour trouver le chemin du tableau que vous souhaitez inspecter ou intégrer Platform.
Format d’API
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root

Paramètre
Description
{BASE_CONNECTION_ID}
ID de la connexion de base pour votre système de gestion de la relation client.
Requête
curl -X GET \
    'http://platform.adobe.io/data/foundation/flowservice/connections/{BASE_CONNECTION_ID}/explore?objectType=root' \
    -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}'

Réponse
Une réponse positive est un ensemble de tables de votre système de gestion de la relation client. Trouvez la table que vous souhaitez introduire Platform et prenez note de sa path propriété, car vous devez la fournir à l'étape suivante pour inspecter sa structure.
[
    {
        "type": "table",
        "name": "Solution Component Summary",
        "path": "msdyn_solutioncomponentsummary",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Quote Invoicing Product",
        "path": "msdyn_quoteinvoicingproduct",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Opportunity Relationship",
        "path": "customeropportunityrole",
        "canPreview": true,
        "canFetchSchema": true
    }
]

inspect de la structure d’un tableau

Pour inspecter la structure d'une table à partir de votre système de gestion de la relation client, effectuez une demande de GET tout en spécifiant le chemin d'une table en tant que paramètre de requête.
Format d’API
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}

Paramètre
Description
{BASE_CONNECTION_ID}
ID de la connexion de base pour votre système de gestion de la relation client.
{TABLE_PATH}
Chemin d’accès d’un tableau.
Requête
curl -X GET \
    'http://platform.adobe.io/data/foundation/flowservice/connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}' \
    -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}'

Réponse
Une réponse réussie renvoie la structure d’un tableau. Les détails concernant chacune des colonnes du tableau se trouvent dans les éléments du columns tableau.
{
    "format": "flat",
    "schema": {
        "columns": [
            {
                "name": "first_name",
                "type": "string",
                "meta": {
                    "originalType": "String"
                }
            },
            {
                "name": "last_name",
                "type": "string",
                "meta": {
                    "originalType": "String"
                }
            },
            {
                "name": "email",
                "type": "string",
                "meta": {
                    "originalType": "String"
                }
            }
        ]
    }
}

Étapes suivantes

En suivant ce tutoriel, vous avez exploré votre système de gestion de la relation client, trouvé le chemin du tableau que vous souhaitez amener Platform, et obtenu des informations sur sa structure. Vous pouvez utiliser ces informations dans le didacticiel suivant pour collecter des données à partir de votre système de gestion de la relation client et les importer dans Platform .