DocumentazioneExperience PlatformGuida ai connettori di origini

Creare una connessione di base Phoenix utilizzando l'API Flow Service

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Argomenti:

Creato per:

  • Sviluppatore

Una connessione di base rappresenta la connessione autenticata tra un'origine e Adobe Experience Platform.

Questo tutorial illustra i passaggi necessari per creare una connessione di base e connettere l'account Phoenix a Adobe Experience Platform utilizzando l'API Flow Service.

Introduzione

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

  • Origini: Experience Platform consente di acquisire dati da varie origini e allo stesso tempo di strutturare, etichettare e migliorare i dati in arrivo tramite i servizi Experience Platform.
  • Sandbox: Experience Platform fornisce sandbox virtuali che suddividono una singola istanza Experience Platform in ambienti virtuali separati, utili per le attività di sviluppo e aggiornamento delle applicazioni di esperienza digitale.

Le sezioni seguenti forniscono informazioni aggiuntive che è necessario conoscere per connettersi correttamente a Phoenix utilizzando l'API Flow Service.

Raccogli le credenziali richieste

Per connettere l'account Phoenix a Experience Platform, è necessario fornire le credenziali di autenticazione seguenti.

Credenziali
Descrizione
host
Indirizzo IP o nome host del server Phoenix.
username
Nome utente utilizzato per accedere al server Phoenix.
password
La password corrispondente all’utente.
port
Porta TCP utilizzata dal server Phoenix per l'ascolto delle connessioni client. Se ci si connette a Azure HDInsights, specificare la porta come 443. Se questo parametro non viene specificato, il valore predefinito è 8765.
httpPath
URL parziale corrispondente al server Phoenix. Specificare /hbasephoenix0 se si utilizza il cluster HDInsights Azure.
enableSsl
Valore booleano. Specifica se le connessioni al server sono crittografate tramite SSL.
connectionSpec.id
La specifica di connessione restituisce le proprietà del connettore di un'origine, incluse le specifiche di autenticazione relative alla creazione delle connessioni di base e di origine. ID della specifica di connessione per Phoenix: 102706fb-a5cd-42ee-afe0-bc42f017ff43

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

Utilizzo delle API di Platform

Per informazioni su come effettuare correttamente chiamate alle API di Platform, consulta la guida in guida introduttiva alle API di Platform.

Creare una connessione di base

Una connessione di base mantiene le informazioni tra l’origine e Platform, incluse le credenziali di autenticazione dell’origine, lo stato corrente della connessione e l’ID univoco della connessione di base. L’ID della connessione di base consente di esplorare e navigare tra i file dall’interno dell’origine e identificare gli elementi specifici che desideri acquisire, comprese le informazioni relative ai tipi di dati e ai formati.

Per creare una connessione di base, effettuare una richiesta POST all'endpoint /connections fornendo le credenziali di autenticazione Phoenix nel corpo della richiesta.

Formato API

POST /connections

Richiesta

La richiesta seguente crea una connessione di base per Phoenix:

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: {ORG_ID}' \
  -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
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
Porta TCP per la connessione Phoenix.
auth.params.httpPath
Percorso HTTP parziale per la connessione Phoenix.
auth.params.enableSsl
Il valore booleano che specifica se le connessioni al server sono crittografate utilizzando SSL.
connectionSpec.id
ID della specifica di connessione Phoenix: 102706fb-a5cd-42ee-afe0-bc42f017ff43.

Risposta

In caso di esito positivo, la risposta restituisce i dettagli della connessione appena 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, è stata creata una connessione di base Phoenix utilizzando l'API Flow Service. Puoi utilizzare questo ID connessione di base nelle seguenti esercitazioni:

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089