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 fornendo le credenziali di autenticazione Salesforce Service Cloud come parte dei parametri della richiesta.

Formato API

POST /connections

Richiesta

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

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": "Salesforce Service Cloud account for ACME data (basic auth)",
      "description": "Salesforce Service Cloud account for ACME data (basic auth)",
      "auth": {
          "specName": "Basic Authentication",
          "params": {
            "environmentUrl": "https://acme-enterprise-3126.my.salesforce.com",
            "username": "acme-salesforce-service-cloud",
            "password": "xxxx",
            "securityToken": "xxxx"
        }
      },
      "connectionSpec": {
          "id": "cb66ab34-8619-49cb-96d1-39b37ede86ea",
          "version": "1.0"
      }
  }'
ParametroDescrizione
auth.params.environmentUrlURL dell'istanza Salesforce Service Cloud.
auth.params.usernameIl nome utente associato al tuo account Salesforce Service Cloud.
auth.params.passwordLa password associata al tuo account Salesforce Service Cloud.
auth.params.securityTokenIl token di sicurezza associato al tuo account Salesforce Service Cloud.
connectionSpec.idID della specifica di connessione Salesforce Service Cloud: cb66ab34-8619-49cb-96d1-39b37ede86ea

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

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": "Salesforce Service Cloud account for ACME data (OAuth2)",
      "description": "Salesforce Service Cloud account for ACME data (OAuth2)",
      "auth": {
          "specName": "OAuth2 Client Credential",
          "params":
            "environmentUrl": "https://acme-enterprise-3126.my.salesforce.com",
            "clientId": "xxxx",
            "clientSecret": "xxxx",
            "apiVersion": "60.0"
        }
      },
      "connectionSpec": {
          "id": "cb66ab34-8619-49cb-96d1-39b37ede86ea",
          "version": "1.0"
      }
  }'
ProprietàDescrizione
auth.params.environmentUrlURL dell'istanza Salesforce Service Cloud.
auth.params.clientIdID client associato all'account Salesforce Service Cloud.
auth.params.clientSecretIl segreto client associato al tuo account Salesforce Service Cloud.
auth.params.apiVersionVersione REST API dell'istanza Salesforce Service Cloud in uso.
connectionSpec.idID della specifica di connessione Salesforce Service Cloud: cb66ab34-8619-49cb-96d1-39b37ede86ea.

Risposta

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

{
    "id": "4267c2ab-2104-474f-a7c2-ab2104d74f86",
    "etag": "\"0200f1c5-0000-0200-0000-5e4352bf0000\""
}

Passaggi successivi

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

Experience Platform