Exploration d’une base de données à l’aide de l’API Flow Service

Ce tutoriel utilise l’API Flow Service pour explorer le contenu et la structure de fichiers d’une base de données tierce.

Prise en main

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

Les sections suivantes apportent des informations supplémentaires dont vous aurez besoin pour vous connecter à une base de données tierce à l’aide de l’API Flow Service.

Collecter les informations d’identification requises

Ce tutoriel nécessite que vous disposiez d’une connexion valide à la base de données tierce à partir de laquelle vous souhaitez ingérer des données. Une connexion valide implique l’identifiant de spécification de connexion et l’identifiant de connexion de votre base de données. Vous trouverez plus d’informations sur la création d’une connexion à la base de données et la récupération de ces valeurs dans la présentation des connecteurs source.

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 d’API, voir la section concernant la lecture d’exemples d’appels d’API dans le guide de dépannage Experience Platform.

Collecte des valeurs des en-têtes requis

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

Toutes les ressources qui se trouvent dans Experience Platform, y compris celles liées à la 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 du sandbox dans lequel l’opération sera effectuée :

Toutes les requêtes qui contiennent un payload (POST, PUT, PATCH) nécessitent un en-tête de type de média supplémentaire :

Exploration des tableaux de données

À l’aide de l’identifiant de connexion à votre base de données, vous pouvez explorer vos tableaux de données en effectuant des requêtes de GET. Utilisez l’appel suivant pour trouver le chemin de la table que vous souhaitez inspecter ou ingérer dans Platform.

Format d’API

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root

Requête

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connections/6990abad-977d-41b9-a85d-17ea8cf1c0e4/explore?objectType=root' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse

Une réponse réussie renvoie un tableau de tableaux de votre base de données. Recherchez la table que vous souhaitez importer dans Platform et notez sa propriété path, car vous devez la fournir à l'étape suivante pour inspecter sa structure.

[
    {
        "type": "table",
        "name": "test1.Mytable",
        "path": "test1.Mytable",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "test1.austin_demo",
        "path": "test1.austin_demo",
        "canPreview": true,
        "canFetchSchema": true
    }
]

Inspect de la structure d’un tableau

Pour inspecter la structure d’un tableau de votre base de données, effectuez une requête de GET tout en spécifiant le chemin d’un tableau comme paramètre de requête.

Format d’API

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}

Requête

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connections/6990abad-977d-41b9-a85d-17ea8cf1c0e4/explore?objectType=table&object=test1.Mytable' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse

Une réponse réussie renvoie la structure de la table spécifiée. Les détails concernant chacune des colonnes de la table se trouvent dans les éléments du tableau columns.

{
    "format": "flat",
    "schema": {
        "columns": [
            {
                "name": "TestID",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "Name",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            }
        ]
    }
}

Étapes suivantes

En suivant ce tutoriel, vous avez exploré votre base de données, trouvé le chemin de la table que vous souhaitez ingérer dans Platform et obtenu des informations sur sa structure. Vous pouvez utiliser ces informations dans le tutoriel suivant pour collecter des données de votre base de données et les importer dans Platform.