Show Menu
ARGOMENTI×

Creare un connettore Couchbase utilizzando l'API del servizio di flusso

Il connettore Couchbase è in versione beta. Le funzioni e la documentazione sono soggette a modifiche.
Flow Service è utilizzato per raccogliere e centralizzare i dati dei clienti da varie fonti diverse e portarli in Adobe Experience Platform. Il servizio fornisce un'interfaccia utente e RESTful API da cui sono collegate tutte le origini supportate.
Questa esercitazione utilizza l’API del servizio di flusso per guidarti attraverso i passaggi necessari per connettere Couchbase alla piattaforma Experience.

Introduzione

Questa guida richiede una buona conoscenza dei seguenti componenti di Adobe Experience Platform:
  • Origini : Experience Platform consente di acquisire dati da varie fonti, fornendo al contempo la possibilità di strutturare, etichettare e migliorare i dati in arrivo tramite i servizi della piattaforma.
  • Sandbox : Experience Platform fornisce sandbox virtuali che dividono una singola istanza della piattaforma in ambienti virtuali separati per sviluppare e sviluppare applicazioni per esperienze digitali.
Le sezioni seguenti forniscono informazioni aggiuntive che sarà necessario conoscere per collegarsi correttamente a Couchbase utilizzando l'API del servizio di flusso.

Raccogli credenziali richieste

Credenziali
Descrizione
connectionString
Stringa di connessione utilizzata per connettersi all'istanza di Couchbase. Il pattern della stringa di connessione per Couchbase è Server={SERVER}; Port={PORT};AuthMech=1;CredString=[{\"user\": \"{USER}\", \"pass\":\"{PASS}\"}]; . Per ulteriori informazioni sull'acquisizione di una stringa di connessione, vedere questo documento Couchbase.
connectionSpec.id
Identificatore necessario per creare una connessione. L'ID della specifica di connessione fissa per Couchbase è 1fe283f6-9bec-11ea-bb37-0242ac130002 .

Lettura di chiamate API di esempio

Questa esercitazione fornisce esempi di chiamate API per dimostrare come formattare le richieste. Questi includono percorsi, intestazioni richieste e payload di richieste formattati correttamente. Viene inoltre fornito un JSON di esempio restituito nelle risposte API. Per informazioni sulle convenzioni utilizzate nella documentazione per le chiamate API di esempio, consulta la sezione come leggere le chiamate API di esempio nella guida alla risoluzione dei problemi della piattaforma Experience.

Raccogli valori per le intestazioni richieste

Per effettuare chiamate alle API della piattaforma, dovete prima completare l'esercitazione di autenticazione. Completando l'esercitazione sull'autenticazione, vengono forniti i valori per ciascuna delle intestazioni richieste in tutte le chiamate API di Experience Platform, come illustrato di seguito:
  • Autorizzazione: Portatore {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Tutte le risorse in Experience Platform, incluse quelle appartenenti a Flow Service, sono isolate in sandbox virtuali specifiche. Tutte le richieste alle API della piattaforma richiedono un'intestazione che specifica il nome della sandbox in cui avrà luogo l'operazione:
  • x-sandbox-name: {SANDBOX_NAME}
Tutte le richieste che contengono un payload (POST, PUT, PATCH) richiedono un'intestazione aggiuntiva per il tipo di supporto:
  • Content-Type: application/json

Creare una connessione

Una connessione specifica un'origine e contiene le credenziali per tale origine. Per l'account Couchbase è necessario un solo connettore, in quanto può essere utilizzato per creare più connettori sorgente per inserire dati diversi.
Formato API
POST /connections

Richiesta
La richiesta seguente crea una nuova connessione Couchbase, configurata dalle proprietà fornite nel payload:.
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"
        }
    }'

Proprietà
Descrizione
auth.params.connectionString
Stringa di connessione utilizzata per connettersi a un account Couchbase. Il pattern della stringa di connessione è: Server={SERVER}; Port={PORT};AuthMech=1;CredString=[{\"user\": \"{USER}\", \"pass\":\"{PASS}\"}]; .
connectionSpec.id
ID specifica connessione Couchbase: 1fe283f6-9bec-11ea-bb37-0242ac130002 .
Risposta
Una risposta corretta restituisce i dettagli della nuova connessione appena creata, incluso il relativo identificatore univoco ( id ). Questo ID è necessario per esplorare i dati nell'esercitazione successiva.
{
    "id": "54997109-07b5-40b7-9971-0907b5a0b75a",
    "etag": "\"280168f5-0000-0200-0000-5ed72b230000\""
}

Passaggi successivi

Seguendo questa esercitazione, hai creato una connessione Couchbase utilizzando l'API del servizio di flusso e hai ottenuto il valore ID univoco della connessione. Puoi usare questo ID nell’esercitazione successiva per imparare a esplorare i database utilizzando l’API del servizio di flusso.