Extensão do Salesforce

Esta é a documentação do Apigee Edge.
Acesse Documentação da Apigee X. informações

Versão: 1.0.2

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

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

Pré-requisitos

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

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

   Você usará a chave privada (.key) como credenciais ao configurar a extensão. Você vai usar o arquivo do 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. Veja as instruções abaixo para configurar o app.

3. Receber a chave do cliente do app conectado. A extensão usará isso ao autenticar com o aplicativo.

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

Configurar um app conectado para acesso pela extensão

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

No Salesforce, um app conectado permite que aplicativos externos se conectem a ele usando 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 referentes à contabilidade; eles não forem 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 de posição.
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 fiquem 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 perfis de aplicativos, marque as caixas de seleção dos perfis de usuários que podem usar esse aplicativo.

    Selecione um perfil que corresponda ao usuário cujo nome de usuário você usará ao configurar a extensão. Verifique também se pelo menos 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 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). A gestão de relacionamento com o cliente ajuda as empresas a entender as necessidades suas necessidades e resolver problemas gerenciando melhor as informações e interações dos clientes, tudo em uma única plataforma que está sempre acessível 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 resultados da operação de inserção.

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

update

Atualize os 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 contendo os resultados da atualização.

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

retrieve

Recuperar registros como sObjects pelos IDs deles. 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 representadas como JSON. Observe que 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

Consulte o Salesforce.com usando a Linguagem de Consulta de Objetos (SOQL, na sigla em inglês) do Salesforce.

<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

Lista 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 contendo sObjects listados como JSON.

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

del

Exclui 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 contendo os resultados da operação.

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

getAccessToken

Recebe o token de acesso da API Salesforce.com. Pode ser usado para consultar APIs REST.

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

Parâmetros de solicitação

Nenhum.

Resposta

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 o seguinte ao configurar e implantar esta 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ões

Especifique valores para as seguintes propriedades de configuração específicas desta extensão.