Documentazione Experience Platform Guida ai connettori di origini

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

Last update: Tue Aug 06 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 per Salesforce utilizzando Flow Service API.

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 e consente 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, utili per le attività di sviluppo e aggiornamento delle applicazioni di esperienza digitale.

Le sezioni seguenti forniscono informazioni aggiuntive che è necessario conoscere per connettere correttamente Platform a un account Salesforce utilizzando l'API Flow Service.

Raccogli le credenziali richieste

L'origine Salesforce supporta l'autenticazione di base e le credenziali client OAuth2.

Autenticazione di base

Per connettere l'account Salesforce a Flow Service utilizzando l'autenticazione di base, specificare i valori per le credenziali seguenti:

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
Credenziali	Descrizione
`environmentUrl`	URL dell'istanza di origine Salesforce. Il formato per `environmentUrl` è `https://[domain].my.salesforce.com`.
`username`	Nome utente per l'account utente Salesforce.
`password`	Password per l'account utente Salesforce.
`securityToken`	Token di sicurezza per l'account utente Salesforce.
`apiVersion`	Facoltativo) Versione REST API dell'istanza Salesforce in uso. Il valore della versione API deve essere formattato con un decimale. Ad esempio, se utilizzi la versione API `52`, devi immettere il valore come `52.0`. Se questo campo viene lasciato vuoto, Experience Platform utilizzerà automaticamente l’ultima versione disponibile.
`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 Salesforce: `cfc0fee1-7dc0-40ef-b73e-d8b134c436f5`.

Per ulteriori informazioni su come iniziare, visita questo documento Salesforce.

Credenziali client OAuth 2

Per connettere l'account Salesforce a Flow Service utilizzando le credenziali client OAuth 2, specificare i valori per le credenziali seguenti:

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
Credenziali	Descrizione
`environmentUrl`	URL dell'istanza di origine Salesforce. Il formato per `environmentUrl` è `https://[domain].my.salesforce.com`
`clientId`	L’ID client viene utilizzato insieme al segreto client come parte dell’autenticazione OAuth2. Insieme, l'ID client e il segreto client consentono all'applicazione di funzionare per conto dell'account identificando l'applicazione in Salesforce.
`clientSecret`	Il segreto client viene utilizzato insieme all’ID client come parte dell’autenticazione OAuth2. Insieme, l'ID client e il segreto client consentono all'applicazione di funzionare per conto dell'account identificando l'applicazione in Salesforce.
`apiVersion`	Versione REST API dell'istanza Salesforce in uso. Il valore della versione API deve essere formattato con un decimale. Ad esempio, se utilizzi la versione API `52`, devi immettere il valore come `52.0`. Se questo campo viene lasciato vuoto, Experience Platform utilizzerà automaticamente l’ultima versione disponibile. Questo valore è obbligatorio per l'autenticazione delle credenziali client OAuth2.
`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 Salesforce: `cfc0fee1-7dc0-40ef-b73e-d8b134c436f5`.

Per ulteriori informazioni sull'utilizzo di OAuth per Salesforce, leggere la Salesforce guida sui flussi di autorizzazione OAuth.

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 un ID di connessione di base, effettuare una richiesta POST all'endpoint /connections e fornire le credenziali di autenticazione Salesforce nel corpo della richiesta.

Formato API

POST /connections

Richiesta

Autenticazione di base

La richiesta seguente crea una connessione di base per Salesforce utilizzando l'autenticazione di base:

code language-shell

code language-shell
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": "ACME Salesforce account", "description": "Salesforce account using basic authentication", "auth": { "specName": "Basic Authentication", "params": "environmentUrl": "https://acme-enterprise-3126.my.salesforce.com", "username": "acme-salesforce", "password": "xxxx", "securityToken": "xxxx" } }, "connectionSpec": { "id": "cfc0fee1-7dc0-40ef-b73e-d8b134c436f5", "version": "1.0" } }'

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": "ACME Salesforce account",
      "description": "Salesforce account using basic authentication",
      "auth": {
          "specName": "Basic Authentication",
          "params":
            "environmentUrl": "https://acme-enterprise-3126.my.salesforce.com",
            "username": "acme-salesforce",
            "password": "xxxx",
            "securityToken": "xxxx"
        }
      },
      "connectionSpec": {
          "id": "cfc0fee1-7dc0-40ef-b73e-d8b134c436f5",
          "version": "1.0"
      }
  }'

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
Proprietà	Descrizione
`auth.params.environmentUrl`	URL dell'istanza Salesforce.
`auth.params.username`	Il nome utente associato al tuo account Salesforce.
`auth.params.password`	La password associata al tuo account Salesforce.
`auth.params.securityToken`	Il token di sicurezza associato al tuo account Salesforce.
`connectionSpec.id`	ID della specifica di connessione Salesforce: `cfc0fee1-7dc0-40ef-b73e-d8b134c436f5`.

Credenziali client OAuth 2

La richiesta seguente crea una connessione di base per Salesforce utilizzando le credenziali client OAuth 2:

code language-shell

code language-shell
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": "ACME Salesforce account", "description": "Salesforce account using OAuth 2", "auth": { "specName": "OAuth2 Client Credential", "params": "environmentUrl": "https://acme-enterprise-3126.my.salesforce.com", "clientId": "xxxx", "clientSecret": "xxxx", "apiVersion": "60.0" } }, "connectionSpec": { "id": "cfc0fee1-7dc0-40ef-b73e-d8b134c436f5", "version": "1.0" } }'

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": "ACME Salesforce account",
      "description": "Salesforce account using OAuth 2",
      "auth": {
          "specName": "OAuth2 Client Credential",
          "params":
            "environmentUrl": "https://acme-enterprise-3126.my.salesforce.com",
            "clientId": "xxxx",
            "clientSecret": "xxxx",
            "apiVersion": "60.0"
        }
      },
      "connectionSpec": {
          "id": "cfc0fee1-7dc0-40ef-b73e-d8b134c436f5",
          "version": "1.0"
      }
  }'

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
Proprietà	Descrizione
`auth.params.environmentUrl`	URL dell'istanza Salesforce.
`auth.params.clientId`	ID client associato all'account Salesforce.
`auth.params.clientSecret`	Il segreto client associato al tuo account Salesforce.
`auth.params.apiVersion`	Versione REST API dell'istanza Salesforce in uso.
`connectionSpec.id`	ID della specifica di connessione Salesforce: `cfc0fee1-7dc0-40ef-b73e-d8b134c436f5`.

Risposta

In caso di esito positivo, la risposta restituisce la connessione di base appena creata insieme al relativo ID univoco.

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"1700df7b-0000-0200-0000-5e3b424f0000\""
}

Passaggi successivi

Seguendo questa esercitazione, è stata creata una connessione di base Salesforce utilizzando l'API Flow Service. Puoi utilizzare questo ID connessione di base nelle seguenti esercitazioni:

recommendation-more-help

337b99bb-92fb-42ae-b6b7-c7042161d089