DocumentazioneExperience PlatformGuida ai connettori di sorgenti

Creare un Phoenix connessione di base tramite Flow Service API

Last update: Tue Nov 14 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Creato per:

  • Sviluppatore

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

Questo tutorial descrive come creare una connessione di base e collegare Phoenix account a Adobe Experience Platform utilizzando Flow Service API.

Introduzione

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

  • Sorgenti: Experienci Platform consente di acquisire dati da varie origini, fornendo al contempo la possibilità di strutturare, etichettare e migliorare i dati in arrivo tramite i servizi Experienci Platform.
  • Sandbox: Experienci Platform fornisce sandbox virtuali che permettono di suddividere una singola istanza Experienci 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 Flow Service API.

Raccogli le credenziali richieste

Per connettersi è necessario fornire le seguenti credenziali di autenticazione Phoenix da Experience Platform.

Credenziali
Descrizione
host
Indirizzo IP o nome host del Phoenix server.
username
Nome utente utilizzato per accedere a Phoenix Server.
password
La password corrispondente all’utente.
port
La porta TCP che Phoenix il server utilizza per l'ascolto delle connessioni client. Se ci si connette a Azure HDInsights, quindi specificare la porta come 443. Se questo parametro non viene specificato, il valore predefinito è 8765.
httpPath
L’URL parziale corrispondente al Phoenix server. Specifica /hbasephoenix0 se si utilizza Azure Cluster HDInsight.
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, consulta questo documento Phoenix.

Utilizzo delle API di Platform

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

Crea 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 al /connections endpoint durante la fornitura del Phoenix credenziali di autenticazione 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
L’host del Phoenix server.
auth.params.username
Il nome utente associato al tuo Phoenix connessione.
auth.params.password
La password associata al tuo Phoenix connessione.
auth.params.port
La porta TCP per Phoenix connessione.
auth.params.httpPath
Percorso http parziale per Phoenix connessione.
auth.params.enableSsl
Il valore booleano che specifica se le connessioni al server sono crittografate utilizzando SSL.
connectionSpec.id
Il Phoenix ID specifica di connessione: 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, hai creato una Phoenix connessione di base tramite Flow Service API. Puoi utilizzare questo ID connessione di base nelle seguenti esercitazioni:

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