Creare un connettore Phoenix utilizzando l'API Flow Service

NOTA

Il connettore Phoenix è 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 connettere un database Phoenix a Experience Platform.

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

Raccogli credenziali richieste

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

Credenziali Descrizione
host Indirizzo IP o nome host del server Phoenix.
username Il nome utente utilizzato per accedere al server Phoenix.
password La password corrispondente all'utente.
port La porta TCP utilizzata dal server Phoenix per ascoltare le connessioni client. Se vi connettete a Azure HDInsights, specificate la porta come 443.
httpPath L'URL parziale corrispondente al server Phoenix. Specificare /hbasephoenix0 se si utilizza il cluster Azure HDInsights.
enableSsl Un valore booleano. Specifica se le connessioni al server sono crittografate utilizzando SSL.
connectionSpec.id Identificatore univoco necessario per creare una connessione. L'ID della specifica di connessione per Phoenix è: 102706fb-a5cd-42ee-afe0-bc42f017ff43

Per ulteriori informazioni su come iniziare, fare riferimento a questo documento Phoenix.

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

Formato API

POST /connections

Richiesta

Per creare una connessione Phoenix, è necessario fornire l'ID univoco della specifica di connessione come parte della richiesta di POST. L'ID della specifica di connessione per Phoenix è 102706fb-a5cd-42ee-afe0-bc42f017ff43.

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": "Phoenix test connection",
        "description": "Phoenix test connection",
        "auth": {
            "specName": "Basic Authentication",
        "params": {
            "host" :  "{HOST}",
            "username" : "{USERNAME}",
            "password" :"{PASSWORD}",
            "port" : {PORT},
            "httpPath" : "{PATH}",
            "enableSsl" : {SSL}
            }
        },
        "connectionSpec": {
            "id": "102706fb-a5cd-42ee-afe0-bc42f017ff43",
            "version": "1.0"
        }
    }'
Proprietà Descrizione
auth.params.host L'host del server Phoenix.
auth.params.username Il nome utente associato alla connessione Phoenix.
auth.params.password La password associata alla connessione Phoenix.
auth.params.port La porta TCP per la connessione Phoenix.
auth.params.httpPath Il percorso http parziale per la connessione Phoenix.
auth.params.enableSsl Valore booleano che specifica se le connessioni al server sono crittografate utilizzando SSL.
connectionSpec.id ID specifica di connessione Phoenix: 102706fb-a5cd-42ee-afe0-bc42f017ff43.

Risposta

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

{
    "id": "0d982fff-c443-403e-982f-ffc443f03e37",
    "etag": "\"830082dc-0000-0200-0000-5e84ee560000\""
}

Passaggi successivi

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

In questa pagina