REDA One Centro de ajuda
PT
Idioma
English EN Español ES Português PT Italiano em breve Français FR Deutsch em breve العربية em breve
reda.one ↗
Início / REDA One / Integrações / APIs e dados / Lendo dados da REDA pelas APIs do Salesforce

Lendo dados da REDA pelas APIs do Salesforce

Se você precisa levar dados da REDA para uma ferramenta de relatórios, um data warehouse ou um middleware, a boa notícia é que não há nada específico da REDA para aprender. Tudo o que você vê na REDA é um registro do Salesforce, e a REDA roda inteiramente na plataforma Salesforce — então qualquer ferramenta que já fale as interfaces padrão do Salesforce consegue ler e gravar os dados da REDA sem nenhuma camada proprietária no meio. Este artigo serve de orientação: explica por que isso é assim, indica a documentação oficial do Salesforce para o como, e marca o único limite que vale a pena conhecer — a diferença entre extrair dados e a forma separada pela qual a REDA recebe formulários web.

Como chegar lá. Isto não é uma tela dentro da REDA. O acesso programático é definido nas próprias configurações da sua organização Salesforce — a configuração padrão de aplicativos conectados e de autenticação — que fica fora dos aplicativos da REDA.
Acesso necessário. O acesso padrão à API do Salesforce precisa estar habilitado na sua organização, e a conta com a qual a sua ferramenta se conecta precisa de permissão sobre os registros da REDA que ela vai tocar. Essa permissão funciona exatamente como funciona para uma pessoa: uma integração que lê faturas precisa do mesmo acesso que um humano precisaria para ver essas faturas.

O que isso significa na prática

A REDA é instalada como um conjunto de pacotes gerenciados na plataforma Salesforce. Os registros dela são registros padrão do Salesforce, o que significa que podem ser consultados, incluídos em relatórios e exportados pelas próprias interfaces programáticas da plataforma — as mesmas APIs REST, de dados em massa (bulk) e demais que o Salesforce oferece para qualquer organização. A conexão usa a autenticação padrão do Salesforce; não existe um login separado da REDA para integrações.

A consequência prática: se a sua ferramenta de BI, o seu carregador de data warehouse ou a sua plataforma de integração já tem um conector do Salesforce, ela já consegue alcançar os dados da REDA hoje. Você a aponta para a sua organização, autentica da forma padrão e consulta os registros que a REDA administra — propriedades, contratos de locação, faturas e o resto — como faria com qualquer dado do Salesforce.

O que a REDA entrega e o que não entrega

Vale a pena ser preciso sobre quais partes são da REDA e quais são simplesmente da plataforma:

NecessidadeO que usar
Receber envios de formulários web para dentro da REDA, sem códigoO REDA Data Service — a única superfície de entrada empacotada da REDA
Ler ou gravar registros da REDA a partir das suas ferramentasAs APIs padrão do Salesforce — nada específico da REDA

Além do Data Service, a REDA não acrescenta nenhuma API de leitura proprietária e não precisa de nenhuma. Ela também não entrega nenhuma conexão de saída empacotada: a REDA não chama os seus sistemas por conta própria. A direção é de mão única por design — você extrai da REDA, usando as APIs da plataforma, em vez de a REDA enviar dados para você.

Documentação oficial do Salesforce. Como a REDA se apoia inteiramente nas interfaces padrão do Salesforce, a referência autorizada para autenticação, sintaxe de consulta e os endpoints da API é a do próprio Salesforce — não este Centro de ajuda. Comece pelo Guia do desenvolvedor da API REST do Salesforce e pela documentação de aplicativos conectados e OAuth.

Orientações práticas

Algumas coisas para ter em mente ao planejar uma integração:

Respeite as permissões dos registros. A sua conta de integração enxerga exatamente o que as permissões dela autorizam, igual a uma pessoa com sessão iniciada — então conceda a ela o acesso de que precisa e nada além. Se ela precisa ler faturas, conceda acesso a faturas.
Teste primeiro em um sandbox. Valide suas consultas e quaisquer gravações em uma organização que não seja de produção antes de apontá-las para dados reais.
Espere que os nomes internos dos campos sejam diferentes dos rótulos. O nome programático de um campo nem sempre é o rótulo que você vê na tela. A referência de campos da sua própria organização, dentro da Configuração do Salesforce, é a fonte da verdade para esses nomes; este Centro de ajuda se mantém no nível dos rótulos, por escolha de design.
Considere um relatório antes de uma integração. Se o seu objetivo é um painel ou uma extração periódica, os relatórios integrados da REDA podem resolver isso sem nenhum trabalho de API. Consulte Criando relatórios.

Exemplo prático: um painel de caixa noturno

O analista da Meridian Properties quer um painel de caixa que se atualize durante a noite. Ele conecta a ferramenta de relatórios à organização por meio de um aplicativo conectado padrão, autenticando-se da forma habitual do Salesforce, como um usuário de integração com acesso somente leitura às faturas. Toda noite a ferramenta consulta as faturas e os saldos da REDA e atualiza o painel — sem endpoint específico da REDA, sem chave, apenas o acesso padrão do Salesforce limitado ao que o analista tem permissão de ver.

O que vem a seguir

  1. REDA Data Service: conecte seus formulários — a contraparte de entrada, para levar formulários web para dentro da REDA.
  2. Mensageria com a REDA Connect — outro produto que convive com a REDA na mesma organização.
  3. Criando relatórios — a forma de extrair dados dentro da plataforma, sem uma integração.
  4. Entendendo o acesso na REDA — o modelo de permissões que a sua conta de integração herda.

Perguntas frequentes

Somente o Data Service usa uma chave, e apenas para receber formulários web. O acesso geral de leitura/gravação aos dados da REDA usa a autenticação padrão do Salesforce, não uma chave da REDA.

A plataforma permite gravações em tudo o que as permissões de uma conta autorizarem — mas a automação da REDA espera que os registros sejam criados pelas suas próprias telas e ações, que criam os registros e as etapas relacionadas que uma gravação direta pularia. Antes de programar gravações em massa na REDA, converse com o seu parceiro REDA para que a automação continue disparando corretamente.

Na referência de campos da sua própria organização, dentro da Configuração do Salesforce. Este Centro de ajuda descreve os campos pelos rótulos que aparecem na tela, e não pelos nomes internos — a documentação oficial do Salesforce e a Configuração da sua organização são onde vivem os nomes programáticos.

Isso foi útil?