Salesforce

Saiba mais sobre o conector Salesforce e como usá-lo na Digibee Integration Platform.

O conector Salesforce permite realizar operações na plataforma Salesforce.

Parâmetros

Dê uma olhada nos parâmetros de configuração do conector. Parâmetros suportados por expressões Double Braces estão marcados com (DB).

Aba General

Parâmetro	Descrição	Valor padrão	Tipo de dado
Fail On Error	Se ativado, interrompe a execução do pipeline ao ocorrer um erro. Se desativado, a execução continua, mas a propriedade "success" será definida como false.	False	Booleano

Aba Authentication

Parâmetro	Descrição	Valor padrão	Tipo de dado
Salesforce Login URL (DB)	URL usada para autenticação no Salesforce.	N/A	String
Salesforce Client Account	Conta do Connected App com o ID do cliente. Tipo suportado: OAuth Provider.	N/A	Account
OAuth Authentication Flow	Tipo de autenticação usada no app do Salesforce: JWT Bearer Token Flow ou Username-Password Flow.	N/A	String
Operation Account	Conta usada para realizar operações no Salesforce. Contas suportadas: Basic, Certificate-Chain.	N/A	Account
Subject	Usuário usado para autenticação com o app do Salesforce. Disponível apenas com o JWT Bearer Token Flow.	N/A	String

Aba Salesforce API

O conector Salesforce pode recuperar automaticamente todas as entidades disponíveis na plataforma Salesforce para simplificar a configuração.

Informações importantes:

• Para usar esse recurso, é necessário configurar uma conta e uma URL válidas do Salesforce. Se nenhuma conta for selecionada em Operation Account ou se as credenciais forem inválidas, o conector muda automaticamente para o modo RAW, que exige configuração manual.

• Em Cápsulas, apenas o modo RAW é suportado. Isso significa que todas as configurações, incluindo o parâmetro API Version, devem ser feitas manualmente. O uso da sintaxe Double Braces é suportado.

Reutilização do AuthToken

Ao acessar a aba Salesforce API, o conector gera um token de acesso com validade limitada, que pode expirar.

Para evitar a regeneração frequente do token, a Digibee oferece a funcionalidade de AuthToken Reuse para o fluxo username-password. Isso permite configurar uma nova conexão no portal do Salesforce e reutilizar o token existente.

Veja como configurar esse mecanismo.

Parâmetros da aba Salesforce API

Parâmetro	Descrição	Valor padrão	Tipo de dado
API Version	Versão da API do Salesforce.	{latest version}	String
API Protocol	API do Salesforce a ser usada: Bulk, Bulk 2.0, RAW e Rest.	N/A	String
Operation	Operação a ser executada na API do Salesforce. Veja abaixo, em uma seção dedicada, as opções disponíveis para cada tipo de API.	N/A	String

Parâmetros do modo RAW

Quando o API Protocol está definido como RAW, os seguintes parâmetros devem ser configurados manualmente:

Parâmetro	Descrição	Valor padrão	Tipo de dado
Method	Método HTTP a ser utilizado.	GET	String
Path (DB)	Caminho do endpoint da API do Salesforce. Certifique-se de incluir a versão da API no caminho.	/services/data/v51/sobjects/Account/	String
Headers (DB)	Cabeçalhos da requisição necessários.	Content-Type: application/json	String
Object Fields	Lista de chaves que devem corresponder às definidas no campo Headers. Essas chaves são obrigatórias aqui para garantir o processamento correto da requisição. Se um header não estiver listado neste campo, ele não será incluído na requisição.	Content-Type	String
Body (DB)	Corpo da requisição.	N/A	JSON

Operações disponíveis por tipo de API

Bulk:

• Abort Job

• Close Job

• Create Batch

• Create Batch Query

• Create Job

• Get All Batches

• Get Batch

• Get Job

• Get Query Result

• Get Query Result Ids

• Get Request

• Get Results

Bulk 2.0:

• Abort Job

• Abort Query Job

• Close Job

• Create Batch

• Create Job

• Create Query Job

• Delete Job

• Delete Query Job

• Get All Jobs

• Get All Query Jobs

• Get Failed Results

• Get Job

• Get Query Job

• Get Query Job Results

• Get Successful Results

• Get Unprocessed Records

Rest:

• Apex Call

• Approval

• Approvals

• Composite

• Composite-batch

• Composite Create SObject Collections

• Composite Delete SObject Collections

• Composite Retrieve SObject Collections

• Composite-tree

• Composite Update SObject Collections

• Composite Upsert SObject Collections

• Create SObject

• Delete SObject

• Delete SObject With Id

• Get Basic Info

• Get Blob Field

• Get Description

• Get Global Objects

• Get Resources

• Get SObject

• Get SObject With Id

• Get Versions

• Limits

• Query

• Query All

• Query More

• Recent

• Search

• Update SObject

• Upsert SObject

Aba Advanced settings

Parâmetro	Descrição	Valor padrão	Tipo de dado
Fields to NULL	Define se os campos do SObject com valores nulos devem ser considerados pela API do Salesforce. Por padrão, o Salesforce ignora SObjects com campos nulos.	False	Booleano

Aba Documentation

Parâmetro	Descrição	Valor padrão	Tipo de dado
Documentation	Campo opcional para descrever a configuração do conector e quaisquer regras de negócio relevantes.	N/A	String

Notas adicionais

Protocolo REST

Operação Composite

Ao usar a operação Composite, é necessário remover o caminho base da propriedade url para garantir que o conector funcione corretamente. Por exemplo:

{
  "method": "POST",
  "url": "/services/data/v59.0/sobjects/Account",
  "referenceId": "refAccount",
  "body": {
    "Name": "Sample Account"
  }
}

Nesse caso, remova a parte /services/data/v59.0 da propriedade url.

Após a edição, a url correta deve ser:

{
  "method": "POST",
  "url": "/sobjects/Account",
  "referenceId": "refAccount",
  "body": {
    "Name": "Sample Account"
  }
}

Operação Composite Update SObject Collections

A saída esperada desta operação é:

{
  "success": true,
  "data": [
    {
      "id": "003ak00000XgSkrAAF",
      "errors": [],
      "success": true
    },
    {
      "id": "003ak00000XgSksAAF",
      "errors": [],
      "success": true
    },
    {
      "id": "003ak00000XgSktAAF",
      "errors": [],
      "success": true
    }
  ]
}

Operação Get Blob Field

Para esta operação, o arquivo pode ser recebido de duas formas:

• Como uma string em base64

• Como um arquivo armazenado no diretório local do pipeline

Por padrão, o arquivo é recebido em formato base64. Para armazená-lo como um arquivo local no diretório do pipeline, ative a flag Save as Local File e especifique o nome do arquivo no campo File Name. Você poderá, em seguida, usar conectores de leitura de arquivos no fluxo para processar o arquivo salvo.

Operação Query

Para qualquer operação do tipo Query (como Query, Query All ou Query More), use o seguinte padrão:

{
  "q": "SELECT Id, LastName, Company FROM Lead ORDER BY CreatedDate DESC LIMIT 5"
}

Se quiser usar expressões com Double Braces, escreva da seguinte forma:

{
  "q": "{{ message.query }}"
}

Protocolo Bulk 2.0

Operação Create Batch

O resultado esperado para esta operação é:

{
  "success": true,
  "data": {
    "HttpResponseCode": "201",
    "HttpResponseText": "Created",
    "Content-type": "text/csv",
    "Sforce-Limit-Info": "api-usage=4184/15000"
  }
}