Creare un connettore Microsoft SQL Server utilizzando l'API Flow Service

NOTA

Il connettore Microsoft SQL Server è in versione beta. Per ulteriori informazioni sull'utilizzo dei connettori con etichetta beta, vedere Panoramica delle sorgenti.

Flow Service viene utilizzato per raccogliere e centralizzare i dati dei clienti da varie origini all'interno di 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 Flow Service per guidarvi nei passaggi necessari per la connessione di Experience Platform a un Microsoft SQL Server (di seguito "SQL Server").

Introduzione

Questa guida richiede una buona conoscenza dei seguenti componenti di Adobe Experience Platform:

  • Origini: Experience Platform consente l'acquisizione di dati da varie origini, fornendo al contempo la possibilità di strutturare, etichettare e migliorare i dati in arrivo tramite Platform i servizi.
  • Sandbox: Experience Platform fornisce sandbox virtuali che dividono una singola Platform istanza 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 SQL Server utilizzando l'API Flow Service.

Raccogli credenziali richieste

Per connettersi a SQL Server, è necessario specificare la seguente proprietà di connessione:

Credenziali Descrizione
connectionString Stringa di connessione associata all'account SQL Server. Il pattern della stringa di connessione di SQL Server è: Data Source={SERVER_NAME}\\<{INSTANCE_NAME} if using named instance>;Initial Catalog={DATABASE};Integrated Security=False;User ID={USERNAME};Password={PASSWORD};.
connectionSpec.id ID utilizzato per generare una connessione. L'ID della specifica di connessione fissa per SQL Server è 1f372ff9-38a4-4492-96f5-b9a4e4bd00ec.

Per ulteriori informazioni su come ottenere una stringa di connessione, fare riferimento a questo documento di SQL Server.

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, consultate la sezione relativa a come leggere chiamate API di esempio nella guida alla risoluzione dei problemi di Experience Platform.

Raccogli valori per le intestazioni richieste

Per effettuare chiamate alle Platform API, è innanzitutto necessario completare l'esercitazione sull'autenticazione a2/>. Completando l'esercitazione sull'autenticazione, vengono forniti i valori per ciascuna delle intestazioni richieste in tutte le chiamate API Experience Platform, come illustrato di seguito:

  • Authorization: Bearer {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 Platform API richiedono un'intestazione che specifica il nome della sandbox in cui verrà eseguita 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 SQL Server è necessaria una sola connessione, in quanto può essere utilizzata per creare più connettori sorgente per inserire dati diversi.

Formato API

POST /connections

Richiesta

Per creare una connessione SQL Server, è necessario fornire l'ID univoco della specifica di connessione come parte della richiesta POST. L'ID della specifica di connessione per SQL Server è 1f372ff9-38a4-4492-96f5-b9a4e4bd00ec.

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 sql-server",
        "description": "Base connection for sql-server",
        "auth": {
            "specName": "Connection String Based Authentication",
            "params": {
                "connectionString": "Data Source={SERVER_NAME}\\<{INSTANCE_NAME} if using named instance>;Initial Catalog={DATABASE};Integrated Security=False;User ID={USERNAME};Password={PASSWORD};"
            }
        },
        "connectionSpec": {
            "id": "1f372ff9-38a4-4492-96f5-b9a4e4bd00ec",
            "version": "1.0"
    }'
Proprietà Descrizione
auth.params.connectionString Stringa di connessione associata all'account SQL Server. Il pattern della stringa di connessione di SQL Server è: Data Source={SERVER_NAME}\\<{INSTANCE_NAME} if using named instance>;Initial Catalog={DATABASE};Integrated Security=False;User ID={USERNAME};Password={PASSWORD};.
connectionSpec.id L'ID della specifica di connessione per SQL Server è: 1f372ff9-38a4-4492-96f5-b9a4e4bd00ec.

Risposta

Una risposta corretta restituisce i dettagli della nuova connessione creata, incluso il relativo identificatore univoco (id). Questo ID è necessario per esplorare il database nell'esercitazione successiva.

{
    "id": "0b8224e4-0de8-4293-8224-e40de80293c6",
    "etag": "\"5802c519-0000-0200-0000-5e4d89520000\""
}

Passaggi successivi

Seguendo questa esercitazione, avete creato una connessione SQL Server utilizzando l'API Flow Service e avete ottenuto il valore ID univoco della connessione. È possibile utilizzare questo ID connessione nell'esercitazione successiva per imparare a esplorare i database o i sistemi NoSQL utilizzando l'API del servizio di flusso.

In questa pagina