Creare una connessione sorgente Generic OData utilizzando l'API Flow Service

NOTA

Il connettore Generic OData è in versione beta. Per ulteriori informazioni sull'utilizzo dei connettori con etichetta beta, consulta la Panoramica delle sorgenti .

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’ Flow Service API per seguire i passaggi necessari per la connessione di Generic OData a Experience Platform.

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 OData utilizzando l'API Flow Service.

Raccogli credenziali richieste

Affinché Flow Service possa connettersi a OData, è necessario fornire valori per le seguenti proprietà di connessione:

Credenziali Descrizione
url URL principale del servizio OData.
connectionSpec.id Identificatore univoco necessario per creare una connessione. L'ID della specifica di connessione per OData è: 8e6b41a8-d998-4545-ad7d-c6a9fff406c3

Per ulteriori informazioni su come iniziare, consulta questo documento OData.

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. È necessaria una sola connessione per ogni account OData in quanto può essere utilizzata per creare più connettori sorgente per inserire dati diversi.

Formato API

POST /connections

Richiesta

Per creare una connessione OData, è necessario fornire l’ID univoco della specifica di connessione come parte della richiesta di POST. L'ID della specifica di connessione per OData è 8e6b41a8-d998-4545-ad7d-c6a9fff406c3.

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": "Protocols",
        "description": "A test connection for a Protocols source",
        "auth": {
            "specName": "Anonymous Authentication",
        "params": {
            "url" :  "{URL}"
            }
        },
        "connectionSpec": {
            "id": "8e6b41a8-d998-4545-ad7d-c6a9fff406c3",
            "version": "1.0"
        }
    }'
Proprietà Descrizione
auth.params.url Host del server OData.
connectionSpec.id ID delle specifiche di connessione OData: 8e6b41a8-d998-4545-ad7d-c6a9fff406c3.

Risposta

Una risposta corretta restituisce la nuova connessione appena creata, incluso l'identificatore di connessione univoco (id). Questo ID è necessario per esplorare i dati nell’esercitazione successiva.

{
    "id": "a5c6b647-e784-4b58-86b6-47e784ab580b",
    "etag": "\"7b01056a-0000-0200-0000-5e8a4f5b0000\""
}

Passaggi successivi

Seguendo questa esercitazione, hai creato una connessione OData utilizzando l'API Flow Service e hai ottenuto il valore ID univoco della connessione. Puoi usare questo ID nell'esercitazione successiva per imparare a esplorare le applicazioni a protocolli utilizzando l'API del servizio di flusso.

In questa pagina