Enriquecimento de dados


Este guia irá lhe mostrar como fazer a sua primeira chamada para a API do RD Station.

Aprenda como fazer a integração de seu aplicativo para enriquecimento de dados usando as APIs RD Station.

Por definição, um aplicativo de enriquecimento de dados deve ser capaz de, com base em algumas informações, retornar outros dados que serão úteis na qualificação do Contato ou para ativar fluxos de automação.

Outro caso de uso que pode ser aplicado é quando o aplicativo externo mantém dados "enriquecedores" em segundo plano e, quando uma novo dado é descoberto ou atualizado, pode gerar também atualização de informações no RD Station.

O processo principal esta resumido neste gráfico:

Enrichment pt br

A seguir nós iremos lhe mostrar como recuperar um único contato usando o endpoint da API utilizando o método GET com UUID. Para fazer isso, você será guiado pelo processo de autenticação para gerar um token de acesso, o qual você utilizará em todas as chamadas de nossa API. Em seguida, iremos fornecer o código para fazer a solicitação que retorna a informação principal formatada como JSON.


Como gerar um token de autenticação

  1. Crie uma conta de teste acessando esse link.
  2. O token de autenticação deve ser obtido seguindo os passos descritos em Autorização.


Como usar Webhooks como um gatilho para o seu aplicativo

Para conectar à sua conta RD Station siga estes passos: Clique em "Sua Conta" -> "Integrações" -> "Webhooks". Por fim, clique no botão Criar Webhook. Na tela que se abrir defina as seguintes configurações:

  1. O nome da sua integração. O objetivo aqui é criar um nome que o ajude para identificar a qual ferramenta essas informações estão sendo enviadas.

  2. A URL do seu aplicativo que receberá a notificação do RD Station com as informações do Contato.

  3. O gatilho que deve ativar o envio da notificação


Neste caso, você pode solicitar que a notificação seja enviada em uma das duas situações abaixo:

Nova conversão: Envie para seu aplicativo Contatos que realizarem alguma conversão no RD Station. Você pode selecionar quais conversões serão ou deixá-las em branco, neste caso a cada nova conversão as informações serão enviadas.

ou

Marcação de oportunidade: Envie os Leads marcados como oportunidade. Exemplo: envie o Contato do RD Station para o aplicativo somente quando estiver marcado como uma oportunidade manualmente ou através de um fluxo de automação.


Como usar fluxos de automação como um gatilho para o seu aplicativo

O fluxo de automação permitirá que você envie o Contato de acordo com as condições definidas pelo fluxo em si, enquanto que através da integração normal, você só pode escolher enviá-lo a cada nova conversão ou quando for marcado como uma oportunidade.

Tudo o que você precisa é inserir no seu fluxo de automação a URL para qual deseja que as informações do contato sejam enviadas, usando a opção Enviar Lead para a URL.

Esta URL é a do seu aplicativo que receberá a solicitação do RD Station com as informações do Contato. A requisição da URL é através de uma solicitação POST via HTTP.

As informações serão enviadas em formato JSON, um exemplo das informações no JSON pode ser encontrada neste link.


Como criar um aplicativo para receber um Contato do RD Station

A criação do aplicativo que receberá os Contatos do RD Station deve atender aos seguintes requisitos:

  • Ser capaz de receber um JSON no formato enviado pelo RD Station;
  • Ser capaz de receber um parâmetro específico para identificar qual cliente está enviando a solicitação (também pode ser um domínio específico para cada cliente). A URL completa com os parâmetros deve ser fácil para o cliente obter e usar nos Webhooks ou Fluxos de Automação do RD Station ;
  • Armazenar o UUID do Contato ( campo UUID do JSON, que é a chave primária para a API) e o e-mail principal (usado como chave para outras aplicações no RD Station).

Como utilizar a API para consultar informações de Contatos (GET)


Returns data about a specific Contact
Request Parameter
uuid Type: String The unique uuid associated to each RD Station Contact.

Response Body Parameters
uuid Type: String The unique uuid associated to each RD Station Contact.
name Type: String Name of the Contact.
email Type: String Email of the Contact.
bio Type: String Notes about the Contact.
website Type: String Website of the Contact.
job_title Type: String Job title of the Contact.
personal_phone Type: String Phone of the Contact.
mobile_phone Type: String Mobile phone of the Contact.
city Type: String City of the Contact.
state Type: String State of the Contact.
country Type: String Country of the Contact.
twitter Type: String Twitter of the Contact.
facebook Type: String Facebook of the Contact.
linkedin Type: String Linkedin of the Contact.
tags Type: Array of Strings Tags of the Contact.

Empty Fields
For empty value fields the following behavior will be adopted:
String and Numbers attributes will not be returned
Array an empty array will be returned []
Boolean Always true or false will be returned
Example:
  {
  "name": "Nome",
  "email": "novo@email.com",
  "job_title": "Developer",
  "website": "http://website.com",
  "mobile": "48 99999-9999",
  "tags": [],
  "city": "Florianópolis",
  "state": "SC",
  "country": "Brasil",
  "cf_custom_field_2": "custom field value2",
  "linkedin": "http://linkedin.com/lead"
}

Como utilizar a API para atualizar informações de Contatos (PATCH)


Updates the properties of a Contact.
Request Parameter
uuid Type: String The unique uuid associated to each RD Station Contact.
Request Body Default Parameters
email Type: String Email of the Contact
name Type: String Name of the Contact
job_title Type: String Job title of the Contact
linkedin Type: String Linkedin profile of the Contact
facebook Type: String Facebook profile of the Contact
state Type: String State of the Contact.
country Type: String Country of the Contact.
twitter Type: String Twitter profile of the Contact
personal_phone Type: String Personal phone of the Contact
mobile_phone Type: String Mobile phone number of the Contact
website Type: String Website of the Contact
tags Type: String[] Tags of the Contact

Request Body Custom Field Parameters
When updating the custom fields information, the attribute keys should be sent as the API name of the custom field. The custom field value should also be adequated accordingly to the field's type.

cf_text_field Type: String Custom field of type text.
cf_text_area Type: String Custom field of type text area.
cf_multiple_choice Type: Array of Strings Custom field of type multiple choice.
cf_radio_button Type: String Custom field of type radio button.
cf_number Type: Integer Custom field of type number.
cf_url Type: String Custom field of type URL.
cf_telephone Type: String Custom field of type telephone.
cf_email Type: String Custom field of type email.
cf_checkbox Type: Boolean Custom field of type checkbox.
cf_combobox Type: String Custom field of type combobox.

Response Body Parameters
uuid Type: String The unique uuid associated to each RD Station Contact.
name Type: String Name of the Contact.
email Type: String Email of the Contact.
bio Type: String Notes about the Contact.
website Type: String Website of the Contact.
job_title Type: String Job title of the Contact.
personal_phone Type: String Phone of the Contact.
mobile_phone Type: String Mobile phone of the Contact.
city Type: String City of the Contact.
state Type: String State of the Contact.
country Type: String Country of the Contact.
twitter Type: String Twitter of the Contact.
facebook Type: String Facebook of the Contact.
linkedin Type: String Linkedin of the Contact.
tags Type: Array of Strings Tags of the Contact.

Empty Fields
For empty value fields the following behavior will be adopted:
String and Numbers attributes will not be returned
Array an empty array will be returned []
Boolean Always true or false will be returned
Example:
  {
  "name": "Nome",
  "email": "novo@email.com",
  "job_title": "Developer",
  "website": "http://website.com",
  "mobile": "48 99999-9999",
  "tags": [],
  "city": "Florianópolis",
  "state": "SC",
  "country": "Brasil",
  "cf_custom_field_2": "custom field value2",
  "linkedin": "http://linkedin.com/lead"
}


Como usar a API de campos personalizados para verificar e criar os campos necessários

Para poder atualizar as informações principais, é necessário que os campos que estão sendo atualizados sejam devidamente criados no RD Station. Se eles não forem criados, ou não existirem, a informação não poderá ser usada para fins específicos (ex: segmentações, fluxos de automação ou lead scoring).

Idealmente, no momento da configuração de integração, o sistema externo deve verificar a existência dos campos necessários para o enriquecimento de dados nos casos de uso mapeados e se não forem encontrados, o aplicativo deve criar esses campos sem a necessidade de configuração manual. Esses detalhes podem ser verificados na seção Campos personalizados.