Creare una connessione di base API REST generica utilizzando Flow Service API

NOTA

La Generic REST API la sorgente è in versione beta. Consulta la sezione Panoramica delle origini per ulteriori informazioni sull’utilizzo dei connettori con etichetta beta.

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

Questa esercitazione descrive i passaggi necessari per creare una connessione di base per Generic REST API utilizzando Flow Service API.

Introduzione

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

  • Origini: L’Experience Platform consente di acquisire dati da varie sorgenti e allo stesso tempo di strutturare, etichettare e migliorare i dati in arrivo tramite i servizi Platform.
  • Sandbox: Experience Platform fornisce sandbox virtuali che suddividono una singola istanza di Platform in ambienti virtuali separati per sviluppare e sviluppare applicazioni di esperienza digitale.

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

Raccogli credenziali richieste

Per Flow Service per connettersi con Generic REST API, è necessario fornire credenziali valide per il tipo di autenticazione desiderato. Generic REST API supporta sia il codice di aggiornamento OAuth 2 che l’autenticazione di base. Per informazioni sulle credenziali per i due tipi di autenticazione supportati, vedere le tabelle seguenti.

Codice di aggiornamento OAuth 2

Credenziali Descrizione
host L'URL host della sorgente a cui stai effettuando la richiesta. Questo valore è obbligatorio e non può essere bypassato utilizzando requestParameterOverride.
authorizationTestUrl (Facoltativo) L'URL del test di autorizzazione viene utilizzato per convalidare le credenziali durante la creazione di una connessione di base. Se non viene fornito, le credenziali vengono automaticamente controllate durante il passaggio di creazione della connessione di origine.
clientId (Facoltativo) L'ID client associato al tuo account utente.
clientSecret (Facoltativo) Il segreto client associato al tuo account utente.
accessToken Credenziale di autenticazione principale utilizzata per accedere all’applicazione. Il token di accesso rappresenta l’autorizzazione dell’applicazione per accedere a specifici aspetti dei dati di un utente. Questo valore è obbligatorio e non può essere bypassato utilizzando requestParameterOverride.
refreshToken (Facoltativo) Token utilizzato per generare un nuovo token di accesso quando il token di accesso è scaduto.
expirationDate (Facoltativo) Un valore nascosto che definisce la data di scadenza del token di accesso.
accessTokenUrl (Facoltativo) L'endpoint URL utilizzato per recuperare il token di accesso.
requestParameterOverride (Facoltativo) Proprietà che consente di specificare i parametri delle credenziali da ignorare.
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 Generic REST API è: 4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62.

Autenticazione di base

Credenziali Descrizione
host L'URL host della sorgente a cui stai effettuando la richiesta.
username Nome utente corrispondente al tuo account utente.
password Password corrispondente al tuo account utente.
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 Generic REST API è: 4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62.

Creare una connessione di base

Una connessione di base conserva le informazioni tra l'origine e la piattaforma, incluse le credenziali di autenticazione dell'origine, lo stato corrente della connessione e l'ID di connessione di base univoco. L’ID di connessione di base consente di esplorare e navigare tra i file di origine e di identificare gli elementi specifici da acquisire, comprese le informazioni relative ai tipi di dati e ai formati corrispondenti.

Generic REST API supporta sia l’autenticazione di base che il codice di aggiornamento OAuth 2. Per informazioni su come eseguire l’autenticazione con uno dei due tipi di autenticazione, consulta gli esempi seguenti.

Crea un Generic REST API connessione di base tramite codice di aggiornamento OAuth 2

Per creare un ID di connessione di base utilizzando il codice di aggiornamento OAuth 2, invia una richiesta POST al /connections durante la fornitura delle credenziali OAuth 2.

Formato API

POST /connections

Richiesta

La richiesta seguente crea una connessione di base per Generic REST API:

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": "Generic REST API base connection with OAuth 2 refresh code",
      "description": "Generic REST API base connection with OAuth 2 refresh code",
      "connectionSpec": {
          "id": "4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62",
          "version": "1.0"
      },
      "auth": {
          "specName": "oAuth2RefreshCode",
          "params": {
              "host": "{HOST}",
              "accessToken": "{ACCESS_TOKEN}"
          }
      }
  }'
Proprietà Descrizione
name Nome della connessione di base. Assicurati che il nome della connessione di base sia descrittivo, in quanto puoi utilizzarlo per cercare informazioni sulla connessione di base.
description (Facoltativo) Proprietà che è possibile includere per fornire ulteriori informazioni sulla connessione di base.
connectionSpec.id ID della specifica di connessione associata a Generic REST API. Questo ID fisso è: 4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62.
auth.specName Il tipo di autenticazione utilizzato per autenticare l’origine in Platform.
auth.params.host L’URL principale utilizzato per connettersi al Generic REST API sorgente.
auth.params.accessToken Il token di accesso corrispondente utilizzato per autenticare l'origine. Questo è necessario per l’autenticazione basata su OAuth.

Risposta

Una risposta corretta restituisce la nuova connessione appena creata, incluso il relativo 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\""
}

Crea un Generic REST API connessione di base tramite autenticazione di base

Per creare una Generic REST API connessione di base utilizzando l’autenticazione di base, effettuare una richiesta di POST al /connections punto finale Flow Service API fornendo le credenziali di autenticazione di base.

Formato API

POST /connections

Richiesta

La richiesta seguente crea una connessione di base per Generic REST API:

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/connections' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'
  -d '{
      "name": "Generic REST API base connection with basic authentication",
      "description": "Generic REST API base connection with basic authentication",
      "connectionSpec": {
          "id": "4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62",
          "version": "1.0"
      },
      "auth": {
          "specName": "Basic Authentication",
          "params": {
              "host": "{HOST}",
              "username": "{USERNAME}",
              "password": "{PASSWORD}"
          }
      }
  }'
Proprietà Descrizione
name Nome della connessione di base. Assicurati che il nome della connessione di base sia descrittivo, in quanto puoi utilizzarlo per cercare informazioni sulla connessione di base.
description (Facoltativo) Proprietà che è possibile includere per fornire ulteriori informazioni sulla connessione di base.
connectionSpec.id ID della specifica di connessione associata a Generic REST API. Questo ID fisso è: 4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62.
auth.specName Tipo di autenticazione utilizzato per collegare l’origine a Platform.
auth.params.host L’URL principale utilizzato per connettersi al Generic REST API sorgente.
auth.params.username Il nome utente che corrisponde al tuo Generic REST API sorgente. Questo è necessario per l’autenticazione di base.
auth.params.password La password che corrisponde alla tua Generic REST API sorgente. Questo è necessario per l’autenticazione di base.

Risposta

Una risposta corretta restituisce la nuova connessione di base creata, incluso l'identificatore di connessione univoco (id). Questo ID è necessario per esplorare la struttura file e il contenuto della tua sorgente nel passaggio successivo.

{
    "id": "9601747c-6874-4c02-bb00-5732a8c43086",
    "etag": "\"3702dabc-0000-0200-0000-615b5b5a0000\""
}

Passaggi successivi

Seguendo questa esercitazione, hai creato un Generic REST API connessione tramite Flow Service e hanno ottenuto il valore ID univoco della connessione. Puoi usare questo ID nell'esercitazione successiva per scoprire come esplorare applicazioni protocolli utilizzando l’API del servizio di flusso.

In questa pagina