Show Menu
SUJETS×

Création d’un connecteur MariaDB à l’aide de l’API du service de flux

Le connecteur MariaDB 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 dans les étapes de connexion de la plate-forme d’expérience à Maria DB.

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 que vous devez connaître pour pouvoir vous connecter à Maria DB à l’aide de l’API de service de flux.

Collecte des informations d’identification requises

Pour que le service de flux se connecte à Maria DB, vous devez fournir la propriété de connexion suivante :
Informations d’identification
Description
connectionString
Chaîne de connexion associée à votre authentification Maria DB.
Consultez ce document pour plus d'informations sur la prise en main de Maria DB.

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

Rechercher les spécifications de connexion

Pour se connecter à Maria DB, un ensemble de spécifications de connexion Maria DB doit exister dans le service de flux. La première étape de la connexion de Platform à Maria DB est de récupérer ces spécifications.
Format d’API
Chaque source disponible possède son propre ensemble de spécifications de connexion unique pour décrire les propriétés du connecteur, telles que les exigences d'authentification. L’envoi d’une requête GET au point de /connectionSpecs terminaison renverra les spécifications de connexion pour toutes les sources disponibles. Vous pouvez inclure la requête property=name=="maria-db" pour obtenir des informations spécifiques pour Maria DB.
GET /connectionSpecs
GET /connectionSpecs?property=name=="maria-db"

Requête
La requête suivante récupère les spécifications de connexion pour Maria DB.
curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connectionSpecs?property=name=="maria-db"' \
    -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 les spécifications de connexion pour Maria DB, y compris son identifiant unique ( id ). Cet identifiant est requis à l’étape suivante pour créer une connexion de base.
{
    "items": [
        {
            "id": "3000eb99-cd47-43f3-827c-43caf170f015",
            "name": "maria-db",
            "providerId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
            "version": "1.0",
            "authSpec": [
                {
                    "name": "Connection String Based Authentication",
                    "type": "connectionStringAuth",
                    "spec": {
                        "$schema": "http://json-schema.org/draft-07/schema#",
                        "type": "object",
                        "description": "defines auth params required for connecting to Maria DB",
                        "properties": {
                            "connectionString": {
                                "type": "string",
                                "description": "connection string to connect to any Maria DB instance.",
                                "format": "password",
                                "pattern": "^(Server=)(.*)(;Port=)(.*)(;Database=)(.*)(;UID=)(.*)(;PWD=)(.*)",
                                "examples": [
                                    "Server=<host>;Port=<port>;Database=<database>;UID=<user name>;PWD=<password>"
                                ]
                            }
                        },
                        "required": [
                            "connectionString"
                        ]
                    }
                }
            ],
        }
    ]
}

Créer une connexion de base

Une connexion de base spécifie une source et contient vos informations d’identification pour cette source. Une seule connexion de base est nécessaire par compte Maria DB car elle peut être utilisée pour créer plusieurs connecteurs de source pour introduire des données différentes.
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": "base connection for maria-db",
        "description": "base connection for maria-db",
        "auth": {
            "specName": "Connection String Based Authentication",
            "params": {
                "connectionString": "{CONNECTION_STRING}"
            }
        },
        "connectionSpec": {
            "id": "3000eb99-cd47-43f3-827c-43caf170f015",
            "version": "1.0"
        }
    }'

Propriété
Description
auth.params.connectionString
Chaîne de connexion associée à votre authentification Maria DB.
connectionSpec.id
La spécification de connexion ( id ) réunie à l'étape précédente.
Réponse
Une réponse réussie renvoie les détails de la connexion de base nouvellement créée, y compris son identifiant unique ( id ). Cet identifiant est nécessaire pour explorer votre enregistrement cloud à l’étape suivante.
{
    "id": "be3a2d71-1fb6-4fea-ba2d-711fb61fea50",
    "etag": "\"02002624-0000-0200-0000-5e41f7040000\""
}

Étapes suivantes

En suivant ce didacticiel, vous avez créé une connexion de base Maria DB à l’aide de l’API Flow Service et obtenu la valeur d’ID unique de la connexion. Vous pouvez utiliser cet ID de connexion de base dans le didacticiel suivant lorsque vous apprendrez à explorer des bases de données ou des systèmes NoSQL à l’aide de l’API Flow Service.