Conectar Salesforce ao Experience Platform usando a API Flow Service
Criado para:
- Desenvolvedor
Leia este guia para saber como você pode conectar sua conta de origem do Salesforce à Adobe Experience Platform 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.
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.
Conectar Salesforce ao Experience Platform em Azure
Leia as etapas abaixo para obter informações sobre como conectar sua origem Salesforce ao Experience Platform em Azure.
Coletar credenciais necessárias
A origem Salesforce dá suporte à autenticação básica e à Credencial do Cliente OAuth2.
Para conectar sua conta do Salesforce ao Flow Service usando a autenticação básica, forneça valores para as seguintes credenciais:
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 a introdução, visite este documento do Salesforce.
Para conectar sua conta do Salesforce ao Flow Service usando a Credencial do Cliente OAuth 2, forneça valores para as seguintes credenciais:
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.
Criar uma conexão base para Salesforce no Experience Platform em Azure
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 conexão base e conectar sua conta do Salesforce ao Experience Platform em Azure, faça uma solicitação POST ao ponto de extremidade /connections
e forneça suas credenciais de autenticação do Salesforce no corpo da solicitação.
Formato da API
POST /connections
A solicitação a seguir cria uma conexão base para Salesforce usando autenticação básica:
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"
}
}'
auth.params.environmentUrl
auth.params.username
auth.params.password
auth.params.securityToken
connectionSpec.id
cfc0fee1-7dc0-40ef-b73e-d8b134c436f5
.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\""
}
A solicitação a seguir cria uma conexão base para Salesforce usando a Credencial do Cliente 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": "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"
}
}'
auth.params.environmentUrl
auth.params.clientId
auth.params.clientSecret
auth.params.apiVersion
connectionSpec.id
cfc0fee1-7dc0-40ef-b73e-d8b134c436f5
.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\""
}
Conectar Salesforce ao Experience Platform no Amazon Web Services (AWS)
Leia as etapas abaixo para obter informações sobre como conectar sua origem do Salesforce ao Experience Platform no AWS.
Pré-requisitos
Para obter informações sobre como configurar a conta do Salesforce para poder se conectar ao Experience Platform no AWS, leia a Salesforce visão geral.
Criar uma conexão base para Salesforce no Experience Platform no AWS
Para criar uma conexão base e conectar sua conta do Salesforce ao Experience Platform no AWS, faça uma solicitação POST ao ponto de extremidade /connections
e forneça os valores apropriados para suas credenciais.
Formato da API
POST /connections
Solicitação
A solicitação a seguir cria uma conexão base para a origem Salesforce no Experience Platform no AWS.
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 'Content-Type: application/json' \
-d '{
"name": "ACME Salesforce account on AWS",
"description": "ACME Salesforce account on AWS",
"auth": {
"specName": "OAuth2 JWT Token Credential",
"params":
"jwtToken": "{JWT_TOKEN},
"clientId": "xxxx",
"clientSecret": "xxxx",
"instanceUrl": "https://acme-enterprise-3126.my.salesforce.com"
}
},
"connectionSpec": {
"id": "cfc0fee1-7dc0-40ef-b73e-d8b134c436f5",
"version": "1.0"
}
}'
Para obter informações sobre como recuperar o Salesforce jwtToken
, leia o manual sobre como configurar uma Salesforce fonte para conexão com o Experience Platform no AWS.
Resposta
Uma resposta bem-sucedida retorna a conexão básica recém-criada, juntamente com a ID exclusiva.
{
"id": "3e908d3f-c390-482b-9f44-43d3d4f2eb82",
"etag": "\"1700df7b-0000-0200-0000-5e3b424f0000\""
}
Verificar o status da conexão
Para verificar o status da conexão, faça uma solicitação GET para o ponto de extremidade /connections
e forneça a ID de conexão básica gerada na etapa de criação.
Formato da API
GET /connections
Solicitação
A solicitação a seguir recupera informações para a ID de conexão base: 3e908d3f-c390-482b-9f44-43d3d4f2eb82
.
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/3e908d3f-c390-482b-9f44-43d3d4f2eb82' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'Content-Type: application/json' \
Resposta
A resposta a seguir exibe informações para a ID de conexão base: 3e908d3f-c390-482b-9f44-43d3d4f2eb82
enquanto está no estado initializing
.
{
"items": [
{
"id": "3e908d3f-c390-482b-9f44-43d3d4f2eb82",
"createdAt": 1736506325115,
"updatedAt": 1736506325717,
"createdBy": "acme@techacct.adobe.com",
"updatedBy": "acme@techacct.adobe.com",
"createdClient": "{CREATED_CLIENT}",
"updatedClient": "{UPDATED_CLIENT}",
"sandboxId": "{SANDBOX_ID}",
"sandboxName": "{SANDBOX_NAME}",
"imsOrgId": "{ORG_ID}",
"name": "JWT Token Auth Authentication E2E-1736506322",
"description": "Base Connection for salesforce E2E",
"connectionSpec": {
"id": "cfc0fee1-7dc0-40ef-b73e-d8b134c436f5",
"version": "1.0"
},
"state": "initializing",
"auth": {
"specName": "OAuth2 JWT Token Credential",
"params": {
"jwtToken": "{JWT_TOKEN}",
"clientId": "{CLIENT_ID}",
"clientSecret": "{CLIENT_SECRET}",
"instanceUrl": "https://acme-enterprise-3126.my.salesforce.com"
}
}
}
}
]
A resposta a seguir exibe informações para a ID de conexão base: 3e908d3f-c390-482b-9f44-43d3d4f2eb82
enquanto está no estado enabled
.
{
"items": [
{
"id": "3e908d3f-c390-482b-9f44-43d3d4f2eb82",
"createdAt": 1736506325115,
"updatedAt": 1736506413299,
"createdBy": "acme@techacct.adobe.com",
"updatedBy": "acme@AdobeID",
"createdClient": "{CREATED_CLIENT}",
"updatedClient": "acme",
"sandboxId": "{SANDBOX_ID}",
"sandboxName": "{SANDBOX_NAME}",
"imsOrgId": "{ORG_ID}",
"name": "JWT Token Auth Authentication E2E-1736506322",
"description": "Base Connection for salesforce E2E",
"connectionSpec": {
"id": "cfc0fee1-7dc0-40ef-b73e-d8b134c436f5",
"version": "1.0"
},
"state": "enabled",
"auth": {
"specName": "OAuth2 JWT Token Credential",
"params": {
"jwtToken": "{JWT_TOKEN}",
"clientId": "{CLIENT_ID}",
"clientSecret": "{CLIENT_SECRET}",
"instanceUrl": "https://adb8-dev-ed.develop.my.salesforce.com",
"orgId": "00DdL000001iPRxUAM"
}
},
"version": "\"6d27f305-40be-41c3-97d4-a701827c34df\"",
"etag": "\"6d27f305-40be-41c3-97d4-a701827c34df\""
}
]
}
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: