Crear un Salesforce conexión base mediante el Flow Service API

Una conexión base representa la conexión autenticada entre un origen y Adobe Experience Platform.

Este tutorial lo acompañará durante los pasos para crear una conexión base para Salesforce uso del Flow Service API.

Introducción

Esta guía requiere una comprensión práctica de los siguientes componentes de Adobe Experience Platform:

  • Fuentes: Experience Platform permite la ingesta de datos desde varias fuentes, al tiempo que le ofrece la capacidad de estructurar, etiquetar y mejorar los datos entrantes mediante Platform servicios.
  • Zonas protegidas: Experience Platform proporciona zonas protegidas virtuales que dividen una sola Platform en entornos virtuales independientes para ayudar a desarrollar y evolucionar aplicaciones de experiencia digital.

Las secciones siguientes proporcionan información adicional que deberá conocer para conectarse correctamente Platform a un Salesforce cuenta que utiliza Flow Service API.

Recopilar credenciales necesarias

El Salesforce El origen de admite la autenticación básica y la credencial de cliente de OAuth2.

Autenticación básica

Para conectar su Salesforce cuenta a Flow Service con la autenticación básica, proporcione valores para las siguientes credenciales:

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
Credencial Descripción
environmentUrl La dirección URL del Salesforce instancia de origen.
username El nombre de usuario de Salesforce cuenta de usuario.
password La contraseña para el Salesforce cuenta de usuario.
securityToken El token de seguridad para Salesforce cuenta de usuario.
apiVersion (Opcional) La versión de la API de REST de Salesforce instancia de que está utilizando. El valor de la versión de la API debe tener formato decimal. Por ejemplo, si utiliza la versión de API 52, entonces debe introducir el valor como 52.0. Si este campo se deja en blanco, el Experience Platform utilizará automáticamente la última versión disponible.
connectionSpec.id La especificación de conexión devuelve las propiedades del conector de origen, incluidas las especificaciones de autenticación relacionadas con la creación de las conexiones base y origen. Identificador de especificación de conexión para Salesforce es: cfc0fee1-7dc0-40ef-b73e-d8b134c436f5.

Para obtener más información sobre cómo empezar, visite este documento de Salesforce.

Credencial de cliente de OAuth 2

Para conectar su Salesforce cuenta a Flow Service Con la credencial de cliente de OAuth 2, proporcione valores para las siguientes credenciales:

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
Credencial Descripción
environmentUrl La dirección URL del Salesforce instancia de origen.
clientId El ID de cliente se utiliza junto con el secreto de cliente como parte de la autenticación OAuth2. Juntos, el ID de cliente y el secreto de cliente permiten que su aplicación funcione en nombre de su cuenta al identificar su aplicación para Salesforce.
clientSecret El secreto de cliente se utiliza junto con el ID de cliente como parte de la autenticación OAuth2. Juntos, el ID de cliente y el secreto de cliente permiten que su aplicación funcione en nombre de su cuenta al identificar su aplicación para Salesforce.
apiVersion La versión de la API de REST de Salesforce instancia de que está utilizando. El valor de la versión de la API debe tener formato decimal. Por ejemplo, si utiliza la versión de API 52, entonces debe introducir el valor como 52.0. Si este campo se deja en blanco, el Experience Platform utilizará automáticamente la última versión disponible. Este valor es obligatorio para la autenticación de credenciales de cliente de OAuth2.
connectionSpec.id La especificación de conexión devuelve las propiedades del conector de origen, incluidas las especificaciones de autenticación relacionadas con la creación de las conexiones base y origen. Identificador de especificación de conexión para Salesforce es: cfc0fee1-7dc0-40ef-b73e-d8b134c436f5.

Para obtener más información sobre el uso de OAuth para Salesforce, lea la Salesforce Guía de flujos de autorización de OAuth.

Uso de API de Platform

Para obtener información sobre cómo realizar llamadas correctamente a las API de Platform, consulte la guía de introducción a las API de Platform.

Crear una conexión base

Una conexión base retiene información entre el origen y Platform, incluidas las credenciales de autenticación del origen, el estado actual de la conexión y el ID único de conexión base. El ID de conexión base le permite explorar y navegar por archivos desde el origen e identificar los elementos específicos que desea introducir, incluida la información sobre sus tipos de datos y formatos.

Para crear un ID de conexión base, realice una solicitud de POST al /connections y proporcione su Salesforce credenciales de autenticación en el cuerpo de la solicitud.

Formato de API

POST /connections

Solicitud

Autenticación básica

La siguiente solicitud crea una conexión base para Salesforce uso de la autenticación básica:

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"
      }
  }'
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
Propiedad Descripción
auth.params.environmentUrl La URL de su Salesforce ejemplo.
auth.params.username El nombre de usuario asociado con su Salesforce cuenta.
auth.params.password La contraseña asociada a su Salesforce cuenta.
auth.params.securityToken El token de seguridad asociado con su Salesforce cuenta.
connectionSpec.id El Salesforce identificador de especificación de conexión: cfc0fee1-7dc0-40ef-b73e-d8b134c436f5.
Credencial de cliente de OAuth 2

La siguiente solicitud crea una conexión base para Salesforce usar la credencial de cliente de OAuth 2:

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"
      }
  }'
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
Propiedad Descripción
auth.params.environmentUrl La URL de su Salesforce ejemplo.
auth.params.clientId El ID de cliente asociado con su Salesforce cuenta.
auth.params.clientSecret El secreto de cliente asociado con su Salesforce cuenta.
auth.params.apiVersion La versión de la API de REST de Salesforce instancia de que está utilizando.
connectionSpec.id El Salesforce identificador de especificación de conexión: cfc0fee1-7dc0-40ef-b73e-d8b134c436f5.

Respuesta

Una respuesta correcta devuelve la conexión recién creada, incluido su identificador único (id). Este ID es necesario para explorar el sistema CRM en el siguiente paso.

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

Pasos siguientes

Al seguir este tutorial, ha creado un Salesforce conexión base mediante el Flow Service API. Puede utilizar este ID de conexión base en los siguientes tutoriales:

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