Extensão do Salesforce

Você está visualizando a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Versão: 1.0.5

Acessar dados na sua conta do Salesforce. Inserir, atualizar, recuperar e consultar dados.

Este conteúdo serve de referência para configurar e usar essa extensão.

Pré-requisitos

Este conteúdo oferece uma referência para configurar e usar essa extensão. Antes de usar a extensão de um proxy de API com a política ExtensionCallout, você precisa:

1. Crie um par de chave privada/certificação RSA x509.

   Você vai usar a chave privada (.key) como credenciais ao configurar a extensão. Você vai usar o arquivo de certificado (.crt) ao criar um app conectado que vai dar à extensão acesso ao Salesforce.

   openssl req -x509 -sha256 -nodes -days 36500 -newkey rsa:2048 -keyout salesforce.key -out salesforce.crt
   
   

2. Configure um app conectado.

   Um app conectado do Salesforce vai fornecer acesso à extensão do Salesforce. Confira as instruções abaixo para configurar o app.

3. Receba a chave do consumidor do app conectado. A extensão vai usar isso ao fazer a autenticação com o app.

   1. Na configuração do Salesforce, no painel de navegação à esquerda, acesse Apps > App Manager.
   2. Na lista, localize o app conectado que você criou.
   3. No menu suspenso à direita da linha do aplicativo, clique em Ver.
   4. Em API (Enable OAuth Settings), localize a Consumer Key e copie o valor dela para um lugar seguro para usar ao configurar a extensão.

Configurar um app conectado para acesso pela extensão

Antes que a extensão do Salesforce possa acessar o Salesforce, você precisa criar um app conectado ao Salesforce para que a extensão possa se conectar ao Salesforce.

No Salesforce, um app conectado permite que aplicativos externos se conectem ao Salesforce por meio de APIs.

Para configurar um app conectado

1. Faça login no Salesforce.
2. Clique no ícone de engrenagem no canto superior direito e em Configuração.
3. No painel de navegação à esquerda, expanda Apps > App Manager.
4. Na página App Manager, clique em Novo app conectado.
5. Em Informações básicas, preencha os campos obrigatórios. Os valores são para contabilidade e não são usados pela extensão.
6. Em API (Enable OAuth Settings), marque a caixa de seleção Enable OAuth Settings.
7. Embora não seja usada pela extensão, digite um URL de callback. Você pode usar http://localhost/ ou outro host de marcador.
8. Marque a caixa de seleção Usar assinaturas digitais.
9. Em Usar assinaturas digitais, clique em Escolher arquivo para localizar e fazer upload do salesforce.crt gerado anteriormente.
10. Na seção Escopos OAuth selecionados, adicione o seguinte para que eles estejam em Escopos OAuth selecionados:
    • Acessar e gerenciar seus dados (API)
    • Faça solicitações em seu nome a qualquer momento (refresh_token, offline_access)
11. Clique em Salvar. Se houver algum erro, talvez seja necessário gerar novamente e fazer upload do arquivo salesforce.crt.
12. Na página do app resultante, clique em Gerenciar.
13. Na página do App Manager do app que você acabou de criar, clique em Editar políticas.
14. Em Políticas do OAuth, clique no menu suspenso Usuários permitidos e, depois, em Os usuários aprovados pelo administrador são pré-autorizados.
15. Clique em Salvar.
16. Na página do app, em Perfis, clique em Gerenciar perfis.

17. Na página Atribuição de perfil de aplicativo, marque as caixas de seleção dos perfis de usuário que podem usar esse app.

    Selecione um perfil que corresponda ao usuário cujo nome de usuário será usado ao configurar a extensão. Verifique também se pelo menos os usuários administradores do sistema têm acesso a esse aplicativo.

    É possível ver a configuração do perfil do usuário no Salesforce. Na área Configuração, expanda Usuários > Usuários, localize o usuário que a extensão vai representar e localize o perfil dele na coluna Perfil.

18. Clique em Salvar.

Sobre o Salesforce

O Salesforce é uma plataforma de gestão de relacionamento com o cliente (CRM). O gerenciamento de relacionamento com o cliente ajuda as empresas a entender as necessidades dos clientes e resolver problemas ao gerenciar melhor as informações e as interações com os clientes. Tudo isso em uma única plataforma que está sempre acessível a partir de qualquer computador ou dispositivo.

Ações

insert

Inserir registros como tipos de sObject.

<Action>insert</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "records":[ records-to-insert ],
  "allOrNone": true | false
}]]></Input>

<Action>insert</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "records":[
    { "Name": "MyAccountName" }
  ],
  "allOrNone": true
}]]></Input>

Parâmetros de solicitação

Resposta

Uma matriz results com os resultados da operação de inserção.

{
  results: [
    { id: '0011U00000LQ76KQAT', success: true, errors: [] },
    { id: '0011U00000LQ76LQAT', success: true, errors: [] }
  ]
}

update

Atualizar registros do Salesforce.

<Action>update</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "records": [ records-to-update ],
  "allOrNone": true | false
}]]></Input>

<Action>update</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "records":[
    {
      "id":"0011U00000LQ76KQAT",
      "Name": "MyNewAccountName"
    }
  ],
  "allOrNone": true
}]]></Input>

Parâmetros de solicitação

Resposta

Uma matriz results que contém os resultados da atualização.

{
  results: [
    { id: '0011U00000LQ76KQAT', success: true, errors: [] },
    { id: '0011U00000LQ76LQAT', success: true, errors: [] }
  ]
}

retrieve

Recuperar registros como sObjects pelos IDs. Retorna todos os campos do tipo sObject.

<Action>retrieve</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "ids":[ IDs-of-records-to-retrieve ]
}]]></Input>

<Action>retrieve</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "ids":["0011U00000LQ76KQAT"]
}]]></Input>

Parâmetros de solicitação

Resposta

Uma matriz records de sObjects representados como JSON. Todas as propriedades dos objetos são incluídas no JSON, mesmo que o valor da propriedade seja nulo.

{
  records: [
    { sobject-json },
    { sobject-json }
  ]
}

querySOQL

Faça consultas no Salesforce.com usando a linguagem de consulta de objetos do Salesforce (SOQL).

<Action>querySOQL</Action>
<Input><![CDATA[{
  "soql": soql-query-statement
}]]></Input>

<Action>querySOQL</Action>
<Input><![CDATA[{
  "soql": "SELECT Id, Name FROM Account"
}]]></Input>

Parâmetros de solicitação

Resposta

Resultados da consulta.

{
  totalSize: 2,
  records: [
    {
      attributes: { attributes-of-record },
      Id: '0011U00000LQ76KQAT',
      Name: 'AccountName1'
    },
    {
      attributes: { attributes-of-record },
      Id: '0011U00000LQ76LQAT',
      Name: 'AccountName2'
    }
  ],
  done: true
}

list

Listar registros do Salesforce.com. Retorna todos os campos do tipo sObject especificado.

<Action>list</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "limit": max-number-of-records,
  "offset": record-index-at-which-to-begin-response-set
}]]></Input>

<Action>list</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "limit": 1000,
  "offset": 0
}]]></Input>

Parâmetros de solicitação

Resposta

Uma matriz records que contém sObjects listados como JSON.

{
  records: [
    { sobject-json },
    { sobject-json }
  ]
}

del

Exclua os registros com os IDs especificados.

<Action>del</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "ids":[ IDs-of-records-to-retrieve ]
}]]></Input>

<Action>del</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "ids":["0011U00000LQ76KQAT"]
}]]></Input>

Parâmetros de solicitação

Resposta

Uma matriz results que contém os resultados da operação.

{
  results:[
    { id: '0011U00000LQ76KQAT', success: true, errors: [] },
    { id: '0011U00000LQ76LQAT', success: true, errors: [] }
  ]
}

getAccessToken

Receber o token de acesso à API do Salesforce.com. Pode ser usado para consultar APIs REST.

<Action>getAccessToken</Action>
<Input><![CDATA[{}]]></Input>

Parâmetros de solicitação

Nenhum.

Resposta

O token de acesso em JSON.

{
  "accessToken":"00D1U0000014m3hqswvoM22I5GTw9EJrztlZ8eSSka88Q",
  "scope":"api",
  "instanceUrl": "https://na85.salesforce.com",
  "id": "https://login.salesforce.com/id/00D1U0004564mutUAA/0051U43214qecVQAQ",
  "tokenType": "Bearer"
}

Referência de configuração

Use as informações a seguir ao configurar e implantar essa extensão para uso em proxies de API.

Propriedades de extensão comuns

As propriedades a seguir estão presentes para cada extensão.

Propriedades deste pacote de extensão

Especifique os valores das seguintes propriedades de configuração específicas para essa extensão.