Documentação Experience Platform Guia dos conectores de origem

Criar uma conexão de base Salesforce usando a API Flow Service

Last update: Tue Aug 06 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Tópicos:

Criado para:

Desenvolvedor

Uma conexão base representa a conexão autenticada entre uma origem e o Adobe Experience Platform.

Este tutorial guiará você pelas etapas para criar uma conexão básica para Salesforce usando a Flow Service API.

Introdução

Este manual necessita de uma compreensão funcional dos seguintes componentes da Adobe Experience Platform:

Fontes: Experience Platform permite que os dados sejam assimilados de várias fontes e fornece a capacidade de estruturar, rotular e aprimorar os dados recebidos usando os serviços do Platform.
Sandboxes: Experience Platform fornece sandboxes virtuais que particionam uma única instância do Platform em ambientes virtuais separados para ajudar a desenvolver aplicativos de experiência digital.

As seções a seguir fornecem informações adicionais que você precisará saber para conectar com êxito o Platform a uma conta do Salesforce usando a API Flow Service.

Coletar credenciais necessárias

A origem Salesforce dá suporte à autenticação básica e à Credencial do Cliente OAuth2.

Autenticação básica

Para conectar sua conta do Salesforce ao Flow Service usando a autenticação básica, forneça valores para as seguintes credenciais:

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
Credencial	Descrição
`environmentUrl`	A URL da instância de origem Salesforce. O formato de `environmentUrl` é `https://[domain].my.salesforce.com`.
`username`	O nome de usuário da conta de usuário Salesforce.
`password`	A senha da conta de usuário Salesforce.
`securityToken`	O token de segurança para a conta de usuário Salesforce.
`apiVersion`	Opcional) A versão da API REST da instância Salesforce que você está usando. O valor da versão da API deve ser formatado com um decimal. Por exemplo, se você estiver usando a versão da API `52`, será necessário inserir o valor como `52.0`. Se esse campo ficar em branco, o Experience Platform usará automaticamente a versão mais recente disponível.
`connectionSpec.id`	A especificação de conexão retorna as propriedades do conector de uma origem, incluindo especificações de autenticação relacionadas à criação das conexões de base e de origem. A ID da especificação de conexão para Salesforce é: `cfc0fee1-7dc0-40ef-b73e-d8b134c436f5`.

Para obter mais informações sobre como começar, visite este documento do Salesforce.

Credencial do cliente OAuth 2

Para conectar sua conta do Salesforce ao Flow Service usando a Credencial do Cliente OAuth 2, forneça valores para as seguintes credenciais:

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
Credencial	Descrição
`environmentUrl`	A URL da instância de origem Salesforce. O formato de `environmentUrl` é `https://[domain].my.salesforce.com`
`clientId`	A ID do cliente é usada em conjunto com o segredo do cliente como parte da autenticação OAuth2. Juntos, a ID do cliente e o segredo do cliente permitem que o aplicativo opere em nome da sua conta, identificando o aplicativo no Salesforce.
`clientSecret`	O segredo do cliente é usado em conjunto com a ID do cliente como parte da autenticação OAuth2. Juntos, a ID do cliente e o segredo do cliente permitem que o aplicativo opere em nome da sua conta, identificando o aplicativo no Salesforce.
`apiVersion`	A versão da API REST da instância Salesforce que você está usando. O valor da versão da API deve ser formatado com um decimal. Por exemplo, se você estiver usando a versão da API `52`, será necessário inserir o valor como `52.0`. Se esse campo ficar em branco, o Experience Platform usará automaticamente a versão mais recente disponível. Esse valor é obrigatório para autenticação de Credencial do cliente OAuth2.
`connectionSpec.id`	A especificação de conexão retorna as propriedades do conector de uma origem, incluindo especificações de autenticação relacionadas à criação das conexões de base e de origem. A ID da especificação de conexão para Salesforce é: `cfc0fee1-7dc0-40ef-b73e-d8b134c436f5`.

Para obter mais informações sobre como usar o OAuth para Salesforce, leia o Salesforce guia sobre Fluxos de Autorização do OAuth.

Uso de APIs da plataforma

Para obter informações sobre como fazer chamadas para APIs da Platform com êxito, consulte o manual sobre introdução às APIs da Platform.

Criar uma conexão básica

Uma conexão base retém informações entre sua origem e a Platform, incluindo as credenciais de autenticação da origem, o estado atual da conexão e sua ID de conexão base exclusiva. A ID de conexão básica permite explorar e navegar pelos arquivos de dentro da origem e identificar os itens específicos que deseja assimilar, incluindo informações sobre os tipos de dados e formatos.

Para criar uma ID de conexão base, faça uma solicitação POST para o ponto de extremidade /connections e forneça suas credenciais de autenticação Salesforce no corpo da solicitação.

Formato da API

POST /connections

Solicitação

Autenticação básica

A solicitação a seguir cria uma conexão base para Salesforce usando autenticação básica:

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
Propriedade	Descrição
`auth.params.environmentUrl`	A URL da instância Salesforce.
`auth.params.username`	O nome de usuário associado à sua conta Salesforce.
`auth.params.password`	A senha associada à sua conta Salesforce.
`auth.params.securityToken`	O token de segurança associado à sua conta Salesforce.
`connectionSpec.id`	A ID da especificação de conexão Salesforce: `cfc0fee1-7dc0-40ef-b73e-d8b134c436f5`.

Credencial do cliente OAuth 2

A solicitação a seguir cria uma conexão base para Salesforce usando a Credencial do Cliente 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
Propriedade	Descrição
`auth.params.environmentUrl`	A URL da instância Salesforce.
`auth.params.clientId`	A ID do cliente associada à sua conta do Salesforce.
`auth.params.clientSecret`	O segredo do cliente associado à sua conta do Salesforce.
`auth.params.apiVersion`	A versão da API REST da instância Salesforce que você está usando.
`connectionSpec.id`	A ID da especificação de conexão Salesforce: `cfc0fee1-7dc0-40ef-b73e-d8b134c436f5`.

Resposta

Uma resposta bem-sucedida retorna a conexão básica recém-criada, juntamente com a ID exclusiva.

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

Próximas etapas

Seguindo este tutorial, você criou uma conexão de base Salesforce usando a API Flow Service. Você pode usar essa ID de conexão básica nos seguintes tutoriais:

recommendation-more-help

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