Show Menu
SUJETS×

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

Le connecteur Couchbase 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 provenant de diverses sources afin de les intégrer à 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 tout au long des étapes nécessaires à la connexion de Couchbase à la plate-forme d’expérience.

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 dont vous aurez besoin pour vous connecter à Couchbase à l’aide de l’API de service de flux.

Collecte des informations d’identification requises

Informations d’identification
Description
connectionString
Chaîne de connexion utilisée pour la connexion à votre instance Couchbase. Le modèle de chaîne de connexion pour Couchbase est Server={SERVER}; Port={PORT};AuthMech=1;CredString=[{\"user\": \"{USER}\", \"pass\":\"{PASS}\"}]; . Pour plus d'informations sur l'acquisition d'une chaîne de connexion, consultez ce document Couchbase.
connectionSpec.id
Identificateur nécessaire pour créer une connexion. L'ID de spécification de connexion fixe pour Couchbase est 1fe283f6-9bec-11ea-bb37-0242ac130002 .

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

Création d’une connexion

Une connexion spécifie une source et contient vos informations d’identification pour cette source. Un seul connecteur est nécessaire par compte Couchbase, car il peut être utilisé pour créer plusieurs connecteurs source afin d’importer des données différentes.
Format d’API
POST /connections

Requête
La requête suivante crée une nouvelle connexion Couchbase, configurée par les propriétés fournies dans la charge utile : .
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": "Couchbase test connection",
        "description": "A test connection for a Couchbase source",
        "auth": {
            "specName": "Connection String Based Authentication",
            "params": {
                    "connectionString": "Server={SERVER}; Port={PORT};AuthMech=1;CredString=[{\"user\": \"{USER}\", \"pass\":\"{PASS}\"}];"
                }
        },
        "connectionSpec": {
            "id": "1fe283f6-9bec-11ea-bb37-0242ac130002",
            "version": "1.0"
        }
    }'

Propriété
Description
auth.params.connectionString
Chaîne de connexion utilisée pour la connexion à un compte Couchbase. Le modèle de chaîne de connexion est le suivant : Server={SERVER}; Port={PORT};AuthMech=1;CredString=[{\"user\": \"{USER}\", \"pass\":\"{PASS}\"}]; .
connectionSpec.id
ID de spécification de connexion Couchbase : 1fe283f6-9bec-11ea-bb37-0242ac130002 .
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 vos données dans le didacticiel suivant.
{
    "id": "54997109-07b5-40b7-9971-0907b5a0b75a",
    "etag": "\"280168f5-0000-0200-0000-5ed72b230000\""
}

Étapes suivantes

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