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 / Adicionando objetos e fontes ao Data Service

Adicionando objetos e fontes ao Data Service

O Data Service já vem configurado de fábrica para os Leads web, mas o motor por trás dele é genérico: você pode apontá-lo para um tipo de registro diferente — solicitações de serviço vindas da web, por exemplo — ou separar duas famílias de formulários em fontes distintas, e tudo isso é configuração. Não há código a escrever, apenas uma linha de permissão para o tipo de registro e uma pequena linha de mapeamento por campo. Este artigo é a receita. Depois de lê-lo, você conseguirá abrir um novo tipo de registro à recepção web, montar seus mapeamentos de campos com valores padrão, escolher um nome de fonte de dados e testar a nova conexão com segurança antes de apontar para ela um formulário em produção. Ele pressupõe que você já leu Conecte seus formulários, que explica o endpoint, o formato da requisição e a autenticação.

Como chegar lá. As linhas de permissão e os mapeamentos de campos do Data Service são configurações de administrador que ficam na configuração da sua organização, junto com os demais registros de configuração da REDA — e não dentro dos próprios aplicativos REDA. Seu administrador os gerencia da mesma forma que os demais registros de configuração da REDA.
Acesso necessário. Este é um trabalho de administrador: você precisa da capacidade de gerenciar os registros de configuração da sua organização. Nenhum conjunto de permissões da REDA concede isso sozinho — é uma capacidade de administrador em nível de organização.
Nunca publique uma chave de API. Cada tipo de registro que você abre carrega a sua própria chave — um segredo específico do ambiente. Defina uma chave nova em cada nova linha de configuração, nunca reutilize a chave de demonstração de uma organização de avaliação e mantenha as chaves reais fora de páginas, repositórios e capturas de tela.
Você usa a edição Sales Cloud da REDA? Este artigo mostra a edição Platform, onde as solicitações de manutenção e de serviço são registros Solicitação de serviço (o Caso padrão). Todo o resto — os campos, as etapas e o comportamento — é igual, salvo indicação em contrário. Consulte Edições da REDA.

Os três componentes básicos

Configurar o Data Service significa trabalhar com três tipos de registro. O primeiro já vem pronto para você; os outros dois são os que você vai construir:

ComponenteQuantosTipo de metadados personalizadosO que faz
Interruptor principalUm, para toda a organizaçãoData Service ConfigLiga todo o Data Service. Já vem ligado em uma organização em funcionamento — não mexa nele.
Linha de configuraçãoUma por tipo de registroData Service SetupDiz qual tipo de registro aceita a recepção e como: interruptores de leitura/envio, os interruptores Create Record e Edit Record e a Auth Key, que ativa a autenticação.
Linhas de mapeamentoUma por campo, por fonteData Service MappingTraduz cada chave da requisição em um campo do registro, com um valor padrão opcional.

A REDA processa o registro a partir dessas linhas exatamente como faz na integração web que já vem pronta: aplica primeiro o valor padrão de cada mapeamento, sobrescreve com os valores que seu formulário enviou e salva o registro. Se não existir nenhuma linha de mapeamento para o tipo de registro e a fonte que você chamou, a REDA retorna um erro; se o salvamento falhar, a falha vai parar nos Registros assíncronos do REDA com o payload completo. Esse comportamento é herdado — você não o configura.

Etapa 1 — Crie ou desbloqueie a linha de configuração

A linha de configuração é o que torna um tipo de registro alcançável. Para um tipo de registro totalmente novo, crie uma linha para ele; para um tipo de registro que já vem de fábrica em espera (como a Solicitação de serviço), desbloqueie a linha que já está lá.

Indique o tipo de registro. A linha identifica qual tipo de registro ela governa; cada tipo de registro tem exatamente uma linha de configuração.
Escolha as operações. Ative os tipos de requisição que você quer — uma requisição de envio para formulários — e as operações que vai permitir: Create Record para registros novos, Edit Record se os formulários forem atualizar registros existentes.
Defina uma Auth Key. Informe uma chave nova. Uma vez definida, toda requisição a esse tipo de registro precisa trazer um cabeçalho x-api-key correspondente — a diferença entre uma porta trancada e uma porta aberta.
Defina uma chave de autenticação em todo tipo de registro exposto à internet. A linha da Solicitação de serviço que já vem no pacote chega com todos os interruptores desligados — o estado de espera seguro. Sempre que você abrir um tipo de registro à web pública, dê a ele uma chave antes de ligar o interruptor de criação, para que ele nunca fique acessível sem autenticação.
A conexão pública precisa ter permissão para gravar o novo tipo de registro. O endpoint é alcançado pela conexão web pública que seu administrador configurou (a mesma que a recepção de Leads que já vem pronta usa). Essa conexão cria registros com a conta dela própria — então, para um tipo de registro totalmente novo, essa conta precisa de permissão para criá-lo e editá-lo, e para gravar os campos que seus mapeamentos preenchem, exatamente como já acontece com os Leads. Se um envio de teste for aceito mas nenhum registro aparecer e os Registros assíncronos do REDA mostrarem um erro de permissões, essa é a causa mais comum. Confirme o acesso da conexão com seu administrador antes de apontar um formulário em produção para um novo tipo de registro.

Etapa 2 — Dê um nome à sua fonte de dados

Uma fonte de dados é um rótulo que agrupa um conjunto de mapeamentos. Ela é o último segmento do endereço do endpoint e permite que o mesmo tipo de registro atenda a vários formulários diferentes sem que os campos deles se choquem. Os Leads web que já vêm prontos usam a fonte Web; você pode usar Web para a sua primeira família de formulários e um nome específico de campanha para outra.

Escolha agora um nome de fonte — você vai carimbá-lo em cada linha de mapeamento na próxima etapa, e seu formulário vai incluí-lo no endereço para o qual ele envia. Use uma fonte por família de formulários: formulários que enviam o mesmo conjunto de chaves e querem os mesmos valores padrão compartilham uma fonte; formulários que precisam de um conjunto de chaves diferente ou de valores padrão diferentes ganham a sua própria.

Etapa 3 — Crie as linhas de mapeamento

Agora traduza cada campo do formulário em um campo da REDA. Adicione uma linha de mapeamento por campo, cada uma trazendo:

Em cada linha de mapeamentoO que você define
Fonte de dadosO nome de fonte que você escolheu na Etapa 2 — precisa corresponder exatamente ao endereço.
Tipo de registroO mesmo tipo de registro da linha de configuração.
Chave da requisiçãoA chave que seu formulário envia (por exemplo, subject).
Campo de destinoO campo da REDA que ela preenche.
Valor padrão (opcional)Um valor usado quando o formulário omite essa chave — útil para carimbar a procedência.

Vale conhecer dois padrões. Use valores padrão para registrar a procedência — o conjunto web que já vem pronto, por exemplo, define a origem do Lead como Web por padrão, de modo que todo registro criado pela web já nasce identificado. E adicione um mapeamento de recordId apenas se você quiser atualizações vindas da web: mapeie recordId para o identificador do registro e combine-o com Edit Record na linha de configuração. Sem esse mapeamento, cada envio cria um registro novo.

Teste qualquer campo de data, número ou lista de seleção antes de depender dele. Os valores que seu formulário envia chegam como texto e são colocados nos campos do registro. Campos de texto simples são diretos; para um destino de data, número ou lista de seleção, envie uma amostra real pela Etapa 4 e confirme que ela chega corretamente antes de apontar para ele um formulário em produção — um valor que o campo não consegue aceitar aparece nos Registros assíncronos do REDA em vez de ser salvo.

Etapa 4 — Teste

Antes de apontar um formulário em produção para a nova conexão, envie você mesmo uma requisição de teste:

Envie o array de chave/valor para .../dataservice/<Tipo de registro>/<Sua fonte> com o cabeçalho x-api-key levando a sua nova chave.
Confirme o registro. Uma resposta bem-sucedida é seguida, um instante depois, pelo novo registro — abra-o e verifique se os campos chegaram onde seus mapeamentos dizem que deveriam.
Force uma falha. Envie uma requisição que omita um campo obrigatório e depois encontre a entrada resultante nos Registros assíncronos do REDA — confirmando que, quando um formulário real falhar, você conseguirá ver exatamente o que ele enviou.

Exemplo prático: um formulário de "relatar um problema"

A Meridian Properties quer um formulário público de "relatar um problema" no seu site de marketing — separado do fluxo de solicitações autenticadas dentro do portal do residente — que crie uma Solicitação de serviço da REDA. Como a linha de configuração da Solicitação de serviço já vem de fábrica em espera, a receita é curta:

EtapaO que a Meridian faz
Desbloquear a linha de configuraçãoAtivar a requisição de envio e Create Record na linha da Solicitação de serviço; definir uma chave de autenticação nova.
Nomear a fonteUsar Web para esta família de formulários.
Adicionar mapeamentosMapear as chaves subject, description e email de quem relata, no formulário, para os campos correspondentes da solicitação de serviço, e adicionar um valor padrão que carimba a origem como web.
TestarEnviar uma amostra; uma solicitação de serviço aparece. Enviar outra sem um campo obrigatório; uma entrada aparece nos Registros assíncronos do REDA com o payload.

O formulário em produção agora registra solicitações de serviço direto na REDA, e o formulário público do site de marketing permanece totalmente separado do formulário autenticado do portal.

O que vem a seguir

  1. REDA Data Service: conecte seus formulários — o motor, o endpoint e o conjunto de Leads web que já vem pronto.
  2. Registros assíncronos do REDA — onde os envios que falham vão parar e como triá-los.
  3. Leads web e solicitações de visita — a recepção de Leads que já vem pronta e que esta receita generaliza.

Perguntas frequentes

Suas linhas de mapeamento precisam corresponder tanto ao tipo de registro quanto ao segmento exato da fonte de dados no endereço que você chamou. Um nome de fonte que não confere é a causa mais comum — verifique se as linhas e o endpoint usam a mesma fonte.

Não — as chaves ficam na linha de configuração de cada tipo de registro, uma por linha. Defina uma chave separada para cada uma. Chaves independentes são justamente o objetivo: você pode rotacionar uma sem afetar as outras.

Não. As regras de validação do próprio tipo de registro se aplicam quando o registro é salvo, exatamente como acontece com um registro criado manualmente. Um envio que não passa em uma regra não cria registro — ele vai parar nos Registros assíncronos do REDA com o payload.

As duas passam pela mesma verificação, mas os formulários devem enviar (POST) — esse é o tipo de requisição que carrega um corpo com valores de campos. As leituras servem para consultar, não para criar.

Isso foi útil?