> For the complete documentation index, see [llms.txt](https://ajuda.consistem.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ajuda.consistem.com.br/consistem-integracoes/areas-de-negocio/comercial/rd-station.md).

# RD Station

### Visão Geral

A integração entre o Consistem ERP e o RD Station Marketing (focada em Eventos de Conversão) tem como objetivo principal impulsionar os resultados de Marketing Digital das empresas. Através da automação de ações de marketing e sincronização de dados, a integração permite nutrir *leads*, gerar oportunidades comerciais qualificadas, reduzir o custo de aquisição de clientes (CAC) e aumentar a taxa de conversão em vendas.

### Requisitos

<table><thead><tr><th width="463">Consistem ERP</th><th>RD Station</th></tr></thead><tbody><tr><td><p><strong>Compatibilidade:</strong> 7.5 ou superiores do Consistem ERP.<br><strong>Módulos:</strong> Comercial, Financeiro e Cadastros Gerais.<br><strong>Licença:</strong> <a href="https://movidesk.consistem.com.br/form/5801/">Aquisição de licença</a> <strong>RDS</strong> ativa junto à Consistem.</p><p>Orientamos o acompanhamento da nossa equipe de consultores.</p></td><td>Aquisição de licença e implantação deve ser verificada com a empresa fornecedora.<br><a href="https://www.rdstation.com/">Saiba mais</a></td></tr><tr><td></td><td><strong>Conta Ativa:</strong> Possuir uma conta ativa na plataforma RD Station Marketing (é possível realizar um teste gratuito de 10 dias).</td></tr></tbody></table>

### Configuração da Integração

**No Consistem ERP**

1. Acesse o programa [Integração (CSINTEGRACAO010)](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/integracao.md), localize o código **RDS** (Integracao API RD Station) e acione o *Editar.*<br>

   <figure><img src="/files/sD9ENjNuVqWGhxkSHQef" alt=""><figcaption></figcaption></figure>
2. No [Cadastro de Integração (CSINTEGRACAO010A)](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-integracao.md), localize a [Aba Dados Gerais](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-integracao/aba-dados-gerais.md) e configure os seguintes campos:
   1. **Usuário Responsável:** Usuário do sistema que receberá notificações em caso de falhas.
   2. **Host Homologação:** URL utilizada para os testes de envio.
   3. **Situação:** Defina como *Ativo*.
   4. **Empresa Integração:** Vincule as empresas do ERP que farão uso deste canal.<br>

      <figure><img src="/files/S3EDzBYZSmf5yKO0sG1x" alt=""><figcaption></figcaption></figure>
3. No grid de parâmetros específicos (abaixo), insira as credenciais coletadas:
   1. **API Key:** Cole a chave token gerada na App Store do RD Station.
   2. **Identificador de Conversa:** Código/nome do canal de origem.
   3. **Envia Todos Clientes:** Opção entre *Sim* (envia o gatilho para qualquer novo cliente) ou *Não* (restringe o envio a apenas alguns Tipos de Nota específicos configurados no botão **Específico**).
   4. **Família do Evento:** Defina o formato aceito pelo RD Station, que atualmente suporta as opções *CDP* (*Customer Data Platform*) ou *Data Lake*.
4. *(Opcional)* No botão **Específico**, se o campo **Envia Todos Clientes** for *Não*, determine explicitamente quais códigos de **Família** e quais **Tipos de Nota** estarão autorizados a disparar a integração.<br>

   <figure><img src="/files/rRGHdoaQ5xGXst8Cv2vo" alt=""><figcaption></figcaption></figure>

**No RD Station**

1. Acesse o site oficial do RD Station e faça o login na sua conta.
2. Navegue até o ambiente de desenvolvedores através do link: `appstore.rdstation.com.br`.
3. No painel (*Dashboard*), clique na opção **Gerar chave de API**.
4. Crie uma nova chave, dê um nome identificador e copie o token gerado.

### Como a Integração Funciona

A comunicação ocorre de forma unidirecional (apenas envio de dados do ERP para o RD Station, sem retorno de informações para alimentar o ERP).

* **Formato de Comunicação:** O Consistem ERP realiza requisições HTTP utilizando o método POST para a API Rest do RD Station.
* **API / Endpoint Utilizado:** `/platform/conversions` (Enviar Cliente RD Station).
* **Autenticação:** É realizada no cabeçalho (*Header*) da requisição através do parâmetro `Query Key "api_key"` contendo o token gerado pelo cliente.
* **Retorno Técnico:** O RD Station responde com o Status 200 (Sucesso) e devolve um identificador único do evento (utilizado apenas para registro de log no ERP). Caso as configurações de família de evento estejam incorretas (diferentes de CDP ou Data Lake), o RD Station rejeitará os dados retornando o Status 400 (Erro).
* **Estratégia de Sincronia:** A comunicação entre o ERP e o RD Station baseia-se na entrega consistente de dados estruturados em tempo real, maximizando o potencial comercial de cada lead e cliente capturado.

### Fluxo do Processo

O fluxo operacional e os métodos de transmissão de dados respeitam a seguinte arquitetura do sistema:

1. **Gatilho (Origem):** Um pedido de venda é cadastrado ou faturado no módulo Comercial do Consistem ERP.
2. **Filtragem:** O motor da integração intercepta o evento e valida os critérios parametrizados (se deve enviar todos os clientes ou se o Tipo de Nota do pedido consta na tabela de exceções específicas).
3. **Mecanismos de Envio de Dados:** O sistema realiza a transmissão dos dados para o RD Station utilizando uma das três modalidades disponíveis:
   1. **Integração Automática (Monitoramento de Pedidos):** Um agendador de tarefas (*Sincronizador*) trabalha em segundo plano monitorando a entrada de novos registros. Sempre que um pedido elegível é criado, o sistema realiza o disparo automatizado.
   2. **Integração Manual de Pedidos:** Interface dedicada para envio sob demanda de pedidos específicos. É utilizada principalmente para fins de testes ou contingência de registros que não foram capturados pela automação.
   3. **Carga Inicial de Dados (Pedidos por Período):** Funcionalidade para popular a base do RD Station com dados históricos. O usuário define a empresa e um período específico (Data Inicial e Final) baseado na digitação para carregar os registros em lote.
      1. **Dados de Envio (Especificação do Leiaute JSON) - O que a Consistem Envia:** Independentemente do mecanismo de envio selecionado (automático, manual ou carga inicial), o Consistem ERP consolida as informações da base e monta um objeto JSON (*payload*) padronizado:<br>

         ```javascript
         JSON

         {
           "event_type": "CONVERSION",
           "event_family": "CDP", 
           "payload": {
             "conversion_identifier": "Identificador_Configurado",
             "name": "Razão Social / Nome do Cliente",
             "email": "email@cliente.com.br",
             "job_title": "Cargo (Se houver)",
             "personal_phone": "Telefone Fixo",
             "mobile_phone": "Telefone Celular",
             "twitter": "",
             "facebook": "",
             "linkedin": "",
             "company_name": "Nome da Empresa do Cliente",
             "company_site": "Website",
             "company_address": "Endereço Completo",
             "client_id": "Código do Cliente no ERP",
             "tags": ["tags_da_conversao"],
             "legal_bases": [
               {
                 "category": "communications",
                 "status": "granted",
                 "legal_basis_type": "consent"
               }
             ]
           }
         }
         ```
      2. **Dados de Retorno (Status e Tratamento de Erros) - O que a Consistem Recebe:** Como fechamento do fluxo de comunicação, o Consistem ERP trata e registra as respostas emitidas pelos endpoints do RD Station:
         1. **Sucesso (HTTP Status 200 OK):** O RD Station confirma o recebimento do JSON e retorna um identificador único de evento (`event_id`) utilizado para auditoria e log internos do ERP, assegurando que o lead entrou na base de marketing.
         2. **Erro (HTTP Status 400 Bad Request):** Sinaliza que a requisição não pôde ser processada pela plataforma de marketing. Ocorre principalmente por falhas cadastrais (como estrutura de campos obrigatórios ausente) ou pela falta de especificação de uma família de eventos válida (*CDP* ou *DATALAKE*).

<p align="center">Esse conteúdo foi útil?</p>

<p align="center"><a href="https://movidesk.consistem.com.br/form/10395/" class="button primary" data-icon="thumbs-up">Sim</a> <a href="https://movidesk.consistem.com.br/form/10395/" class="button primary" data-icon="thumbs-down">Não</a></p>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ajuda.consistem.com.br/consistem-integracoes/areas-de-negocio/comercial/rd-station.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.