Creare un PathFactory connessione di base tramite Flow Service API

Last update: Tue Apr 30 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Argomenti:
Origini

Creato per:

Sviluppatore

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

Leggi questo documento per scoprire come creare una connessione di base per PathFactory utilizzando [Flow Service API] (https://www.adobe.io/experience-platform-apis/references/flow-service/).

Introduzione

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

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

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.

La sezione seguente fornisce informazioni aggiuntive che è necessario conoscere per connettersi correttamente a PathFactory utilizzando Flow Service API.

Raccogli credenziali richieste gather-credentials

Per accedere all’account PathFactory sulla piattaforma, è necessario fornire i seguenti valori:

Credenziali

Descrizione

Nome utente

Il tuo PathFactory nome utente dell’account. Questo è essenziale per identificare l’account nel sistema.

Password

La password associata al tuo PathFactory account. Assicurati che sia protetto per evitare accessi non autorizzati.

Dominio

Il dominio associato al tuo PathFactory account. In genere si riferisce all’identificatore univoco all’interno del PathFactory URL.

Token di accesso

Un token univoco utilizzato per l’autenticazione API per garantire una comunicazione sicura tra i sistemi e PathFactory.

Endpoint API

Endpoint API specifici per l’accesso ai dati: visitatori, sessioni e visualizzazioni di pagina. Ogni endpoint corrisponde a set di dati diversi che è possibile recuperare. Nota: Questi sono predefiniti da PathFactory e sono specifici per i dati a cui intendi accedere:

Endpoint visitatori: /api/public/v3/data_lake_apis/visitors.json
Endpoint sessioni: /api/public/v3/data_lake_apis/sessions.json
Endpoint visualizzazioni pagina: /api/public/v3/data_lake_apis/page_views.json

Per ulteriori informazioni su come proteggere e utilizzare le credenziali e su come ottenere e aggiornare il token di accesso, visita PathFactory Centro assistenza. Questa risorsa offre guide complete sulla gestione delle credenziali e sulla garanzia di un’integrazione API efficace e sicura.

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 un ID di connessione di base, effettua una richiesta POST al /connections endpoint durante la fornitura del PathFactory credenziali di autenticazione come parte del corpo della richiesta.

Formato API

POST /connections

Richiesta

La richiesta seguente crea una connessione di base per PathFactory:

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": "PathFactory base connection",
      "description": "PathFactory base connection",
      "auth": {
          "specName": "Basic Authentication",
          "params": {
              "host": "acme-ab12c3d4e5fg6hijk7lmnop8qrst"
              "clientId": "pathfactory",
              "clientSecret": "xxxx"
          }
      },
      "connectionSpec": {
          "id": "ea1c2a08-b722-11eb-8529-0242ac130003",
          "version": "1.0"
      }
  }'

Proprietà

Descrizione

auth.params.clientId

L’ID client associato al tuo PathFactory applicazione.

auth.params.clientSecret

Il segreto client associato al tuo PathFactory applicazione.

connectionSpec.id

Il PathFactory ID specifica di connessione: ea1c2a08-b722-11eb-8529-0242ac130003.

Risposta

In caso di esito positivo, la risposta restituisce la connessione appena creata, incluso il relativo identificatore univoco di connessione (id). Questo ID è necessario per esplorare i dati nell’esercitazione successiva.

{
    "id": "2fce94c1-9a93-4971-8e94-c19a93097129",
    "etag": "\"d403848a-0000-0200-0000-5e978f7b0000\""
}

Passaggi successivi

Seguendo questa esercitazione, hai creato una PathFactory 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