Conector do Salesforce

::: (info) () Para fazer o download do aplicativo, visite: Biblioteca::::

Introdução

O Salesforce é uma plataforma de software de CRM baseada em nuvem, usada em aplicativos que variam desde o rastreamento de leads de vendas até o gerenciamento de pedidos e estoques.

Objetivo

Este documento detalha o Salesforce REST API Connector encontrado na Tulip Library. Uma vez configurado, essas funções do conector podem ser usadas para recuperar, consultar e modificar dados do Salesforce a partir de um aplicativo Tulip.

Documentação da API

A documentação da API REST do Salesforce pode ser encontrada aqui. Observe que algumas Connector Functions incluídas neste artigo realizam consultas usando SOQL (Salesforce Object Query Language), cuja sintaxe completa está documentada aqui.

:::(Info) (Variações de API) Observação: o Salesforce oferece suporte a várias APIs em uma variedade de métodos, cuja lista completa pode ser encontrada aqui.
Este artigo e os conectores aos quais ele está relacionado foram criados para usar a API REST do Salesforce.
:::

Configuração pela primeira vez

:::(Warning) (Aviso de permissões) Aviso: a geração dos valores a seguir requer permissões de nível de desenvolvedor ou administrador no Salesforce. ::: A autenticação da API do Salesforce segue os padrões OAuth 2.0. O processo a seguir descreve como gerar um token de atualização, que será usado por qualquer aplicativo Tulip para recuperar o token de acesso necessário para se conectar com sucesso ao Salesforce.

1. Crie um aplicativo conectado no Salesforce. Para isso, navegue até o espaço "Setup" (Configuração) no Salesforce. Em seguida, navegue até PLATFORM TOOLS >> Apps >> Connected Apps >> Manage Connected Apps.
2. Crie um novo aplicativo conectado. Inclua:
   a. todos os escopos exigidos pelo seu aplicativo, mas não se esqueça de incluir refresh_token. b. Selecione Ativar configurações do OAuth e insira o URL de retorno de chamada como https://login.salesforce.com/services/oauth2/success.
3. Depois de concluído, clique em Manage Consumer Details (Gerenciar detalhes do consumidor ) para ver sua "Consumer Key" (Chave do consumidor) e "Consumer Secret" (Segredo do consumidor). Eles serão usados posteriormente.
4. Agora, no Tulip, abra a função Connector [Setup] Get Auth Code URL. Copie e cole a "Consumer Key" (chave do consumidor) gerada na Etapa 3 acima como o parâmetro de consulta client_id.
5. "Execute" a Connector Function.
6. Observe que um URL foi gerado como uma "Saída" do Conector. Cole esse URL na janela do navegador.
7. Complete o prompt de autenticação que aparece para autorizar a Tulip a interagir com sua instância do Salesforce.
8. Se for bem-sucedido, seu navegador deverá redirecionar para uma nova página que diz Autorização de aplicativo de acesso remoto. O Código de Autorização pode ser encontrado no URL dessa página.
   Por exemplo, no URL https://login.salesforce.com/services/oauth2/success?code=asdf1234, o Código de Autorização é asdf1234.
9. Salve esse código de autorização. Observe que o código deve terminar com dois símbolos de igual: ==. Se o código terminar em %3D%3D, remova esses caracteres e substitua por ==.
10. Navegue até a função [Setup] Get Refresh Token Tulip Connector. Em Query Parameters (Parâmetros de consulta), cole todas as informações que foram coletadas acima:
    • grant_type= authorization_code
    • redirect_uri= https://login.salesforce.com/services/oauth2/success
    • client_id= a chave do consumidor da Etapa 3 acima
    • client_secret= o segredo do consumidor da Etapa 3 acima
    • code= o Código de autorização da Etapa 9 acima
11. Execute esse conector e salve o refresh_token que aparece na resposta.
12. Por fim, navegue até a função do conector [Auth] Get Access Token. Preencha os seguintes parâmetros de consulta:
    • grant_type= authorization_code
    • client_id= a chave do consumidor da Etapa 3 acima
    • client_secret= o segredo do consumidor da Etapa 3 acima
    • refresh_token= o token de atualização da Etapa 10 acima
13. Execute o conector. Observe que a resposta inclui um access_token, que é mapeado como uma saída. Salve o Conector para salvar o Refresh Token

Quando essa função for capaz de gerar um access_token, a configuração estará concluída! Esse access_token agora pode ser usado em qualquer função de conector subsequente enquanto as configurações de tempo limite definidas na Etapa 2 permitirem.

Detalhes da conexão Tulip

Para permitir que seus conectores façam interface com o Salesforce, insira o subdomínio da instância do Salesforce como o "Subdomínio padrão", nos Detalhes da conexão do conector.
Por exemplo, se a instância do Salesforce pode ser encontrada em sample.my.salesforce.com, então o subdomínio padrão deve ser sample.my.

Observe que todas as funções do conector aqui foram criadas para funcionar com a Salesforce REST API v46.0.

Funções do conector

Existem dois tipos principais de conectores: conectores do tipo objeto e do tipo consulta.
Observe que ambos os conectores exigem um access_token, portanto, certifique-se de executar [Auth] Get Access Token em seu aplicativo antes deles! Geralmente, recomenda-se gerar um novo token de acesso quando o aplicativo ou processo for iniciado e salvá-lo em uma variável de aplicativo para uso posterior.

Conectores de tipo de objeto

• Retorna todos os campos do objeto em questão.
• Use o ponto de extremidade ./services/data/v46.0/sobjects/<Object Name>/<Object ID>
• Exemplo: Conector [Opportunity] Obter todos os campos

Conectores de tipo de consulta

• Retorna apenas os campos especificados na consulta.
• Pode retornar informações vinculadas (por exemplo, o nome da conta relacionado a uma oportunidade) ou agregadas (por exemplo, uma contagem de registros).
• Usar o ponto de extremidade ./services/data/v46.0/query
• Requer escrever uma consulta usando SOQL (documentação here{target=_blank}).
• Exemplo: Conector [Order] Obter todos os pedidos de status

Funções de conector incluídas

As seguintes funções do conector estão incluídas neste pacote e têm o objetivo de servir como uma introdução às funções possíveis por meio da API do Salesforce: * [Setup] Get Auth Code URL & [Setup] Get Refresh Token * Usado somente para a primeira configuração. Consulte acima para obter mais informações.* [Auth] Get Access Token * Usado para gerar um Access Token, que deve ser incluído em todas as funções de conector subsequentes.* Funções [Opportunity]:
* Get All Fields * Retorna todos os campos da oportunidade consultada. Requer o Access Token e o ID da oportunidade.* Change Stage * Atualiza o estágio da oportunidade indicada para o valor especificado.* Funções [Order]: * Get All Orders of Status * Retorna uma lista de todas as ordens de um status especificado.* Count Orders of Status * Retorna uma contagem de todas as ordens de um status especificado.* Get Order Number from ID * Retorna um número de ordem de um ID de ordem especificado.

Para modificar essas funções de acordo com suas necessidades, observe as recomendações abaixo:

1. Para modificar Connector Functions do tipo objeto, basta alterar o objeto indicado no URL. Adicione ou remova novos outputs conforme necessário. 2. Para modificar Connector Functions do tipo consulta, todas as alterações devem ser feitas na Consulta. Isso pode ser encontrado nos Parâmetros da Consulta, com a chave q.
2. Dica: limite o número de respostas de uma consulta com a função LIMIT(number_of_responses)

Encontrou o que estava procurando?

Você também pode acessar community.tulip.co para postar sua pergunta ou ver se outras pessoas tiveram uma pergunta semelhante!