Creare una connessione di origine Microsoft SQL Server utilizzando l'API Flow Service

Flow Service viene utilizzato per raccogliere e centralizzare i dati dei clienti da varie fonti all'interno di Adobe Experience Platform. Il servizio fornisce un’interfaccia utente e un’API RESTful da cui è possibile connettere tutte le sorgenti supportate.

Questa esercitazione utilizza l'API Flow Service per illustrare i passaggi necessari per la connessione di Experience Platform a un Microsoft SQL Server (in seguito denominato "SQL Server").

Introduzione

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

Origini: Experience Platform consente l’acquisizione di dati da varie sorgenti, 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 suddividono una singola Platform istanza in ambienti virtuali separati per sviluppare e sviluppare applicazioni di esperienza digitale.

Le sezioni seguenti forniscono informazioni aggiuntive che sarà necessario conoscere per connettersi 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 delle specifiche di connessione fisse per SQL Server è `1f372ff9-38a4-4492-96f5-b9a4e4bd00ec`.

Per ulteriori informazioni su come ottenere una stringa di connessione, vedere 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 richiesta formattati correttamente. Viene inoltre fornito un esempio di codice JSON restituito nelle risposte API. Per informazioni sulle convenzioni utilizzate nella documentazione per le chiamate API di esempio, consulta la sezione su come leggere le chiamate API di esempio nella guida alla risoluzione dei problemi di Experience Platform .

Raccogli i valori delle intestazioni richieste

Per effettuare chiamate alle API Platform, devi prima completare l’ esercitazione sull’autenticazione. Il completamento dell’esercitazione di autenticazione fornisce i valori per ciascuna delle intestazioni richieste in tutte le chiamate API Experience Platform, come mostrato di seguito:

Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {IMS_ORG}

Tutte le risorse in Experience Platform, comprese quelle appartenenti a Flow Service, sono isolate in sandbox virtuali specifiche. Tutte le richieste alle API Platform richiedono un’intestazione che specifichi 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 di tipo multimediale aggiuntiva:

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 delle specifiche 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`	ID delle specifiche di connessione per SQL Server: `1f372ff9-38a4-4492-96f5-b9a4e4bd00ec`.

Risposta

Una risposta corretta restituisce i dettagli della nuova connessione creata, incluso l’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, è stata creata una connessione SQL Server utilizzando l'API Flow Service e si è 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.