Integração - RD Station CRM

Apenas clientes que contrataram o plano RD CRM com opção de integração conseguem integrar com a Octadesk, ok?

Para acessar a API da RD Station clique aqui. 

1 - Gerar API TOKEN dentro do RD Station;

2 - Verificar ID Empresa (organization_id) dentro do RD Station;

3 - Verificar ID do Responsável (user_id) dentro do RD Station; 

4 - Verificar ID da etapa do funil (deal_stage_id) dentro do RD Station;

5 - Criar um Campo personalizado de pessoa no Octadesk para salvar o ID do contato, gerado pelo RD Station;

6 - Construir um Bot que capture o e-mail que pode ser usado para consulta na API do RD Station;

7 - Verificar se já existe um Contato no RD Station com a informação coletada pelo Bot;

8 - Usar regra de validação para direcionamento quando contato não existir na RD Station;

9 - Cadastrar o contato gerado pelo Bot na RD Station;

10 - Criar uma oportunidade, a partir dos dados coletados pela criação do bot na Octadesk;

11 - Envio de informações em campos personalizados.

O Token é um código de autenticação, utilizado para validar a conta do usuário em determinadas integrações com outras ferramentas.

Para gerar e visualizar seu Token de usuário:

- Acesse sua conta no RD Station CRM;

- Clique em seu nome de usuário, localizado no canto superior direito da página;

- No menu suspenso que será exibido, clique em Perfil;

- Caso o código não conste na tela, clique no botão Gerar Token;

- Copie o código exibido no campo Token da instância.

Nessa etapa, iremos localizar o ID da Empresa, o ideal é ter uma única empresa, para verificar e incluir novos contatos a ela, no caso do exemplo abaixo, criamos a empresa Cliente Pessoa Física e usaremos o seu ID.

O ID fica localizado no final da URL, como no exemplo abaixo.

Exemplo: https://crm.rdstation.com/app#/organizations/637b9b3d7fdb9b00149ea6fc

Nessa etapa, iremos localizar o ID do Responsável, ou seja, o ID do usuário.

Ele será utilizado na etapa de criação de contato e deal, por isso a importância de saber localizá-lo dentro do sistema da RD Station.

Para visualizar esta opção: 

- Acesse sua conta no RD Station CRM;

- Clique em seu nome de usuário, localizado no canto superior direito da página;

- No menu suspenso que será exibido, clique em Configurações; 

- No grupo Seu Time, clique em Convites, Usuários e Equipe; 

- Na tela Convites, clique na aba Usuários, Permissões e Visibilidade.

Nessa etapa, iremos localizar o ID da etapa do funil de vendas. É aconselhável criar um funil somente para a integração, assim evitando de sujar a base existente.

Para isso, basta:

- Na tela de Funis de vendas, clique no botão Adicionar Funil de Vendas;

- Selecione a confirmação;

Será criado um novo funil com as etapas-padrão. 

Caso já queira acessar um funil existente, basta seguir:

- Acesse sua conta no RD Station CRM;

- Clique em seu nome de usuário, localizado no canto superior direito da página;

- No menu suspenso que será exibido, clique em Configurações;

- No grupo "Ajustes da sua conta", clique em "Etapas do funil de vendas".

Caso o ID não apareça no seu funil de vendas, basta ativar o modo de desenvolvedor no perfil da sua conta.

Cada etapa tem um ID diferente, por isso é muito importante saber qual etapa você deseja cadastrar sua deal. Indicamos o cadastro na etapa sem contato, assim poderá mover o card conforme contato com o cliente para sua etapa correspondente. 

O campo personalizado é onde iremos salvar o ID do RD Station, e  utilizá-lo na integração em diversos momentos. Por isso precisamos criá-lo antecipadamente, como no exemplo abaixo.

Lembrando que é necessário ativá-lo e ativar também a opção de pesquisa:

#id-rd-station-contato

Você consegue acesso em Gestão de Contatos >> Campos de pessoas.

Para que a integração com a RD Station funcione corretamente, temos que ter ciência que ela precisa de informação do cliente, e essa informação precisa ser perguntada em determinada fase do bot e a resposta ser salva.

Conseguimos capturar as informações do cliente nas fases de pergunta, podendo ser usadas perguntas prontas que o sistema da Octadesk oferece, ou criar as suas próprias, usando o “Pergunte qualquer coisa”.

Nesse exemplo, usaremos e-mail como dado para consultar se o contato já existe na base da RD Station.

Para fazer essa verificação iremos usar a etapa do Bot chamada “Conecte a outro sistema”, essa etapa nos permite realizar requisições na API da RD Sation para efetuar uma consulta, vamos realizar uma requisição do tipo GET (Nos permite buscar ou consultar uma informação).

A URL da RD Station deve ser inserida no campo “Com quem você quer integrar?” e em seguida Enter:

https://crm.rdstation.com/api/v1/contacts

Ao inserir a URL, outros campos e abas irão aparecer para preenchimento.

Iremos preenchê-las da seguinte forma:

Na opção PARAMS:

Chave: token

Valor: Seu API Token gerado na RD Station 

Cadastre mais um parâmetro e preencha:

Chave: email

Valor: Clique na # ao lado do campo e selecione o e-mail

Na opção HEADER:

Chave: Content-Type

Valor: application/json

Após um campo de valide sua integração será apresentado, iremos preenchê-lo com um e-mail para verificar se ele existe na RD Station, vinculado a um contato.

Importante ressaltar que a integração retornará os dados do contato caso ele exista e retornará o seguinte, caso o e-mail não esteja cadastrado na base:

  "total": 0,

  "has_more": false,

  "contacts": []

Portanto, neste primeiro momento o ideal é utilizar um e-mail que exista na base, para que possamos testar se a integração está funcionando.

É possível ver uma configuração no Bot chamada “Salve as informações encontradas”, esse é um recurso que permite salvar as informações que a API da RD Station retornou em campos do Octadesk.

Agora será o momento de utilizarmos o campo personalizado de pessoas que criamos na etapa 5 deste artigo, para salvarmos o ID do Contato.

Iremos selecionar o item “contacts.0.id”.

Salvando essa informação, irá nos permitir diferenciar contatos que existem na RD Station dos contatos que não existem. Afinal, se ele não existir a integração não retornará nenhum dado e o campo ID RD Station criado no Octadesk não será preenchido.

O Bot possui uma etapa chamada “Valide uma informação”, ela serve para validar se um campo em específico foi preenchido ou não, de acordo com o resultado da validação podemos configurar caminhos diferentes para o Bot. 

Iremos validar através desse campo, o ID RD Station, se ele foi preenchido, usando a regra “Estiver Vazio”.

Ao configurar o Bot para validar se o campo ID RD Station, está vazio ou não, será possível configurar um caminho diferente.

- Se a regra for válida: Significa que não existe um contato cadastrado na RD Station com o e-mail que usamos para validar a integração, portanto será necessário cadastrar esse cliente na RD Station.

Pensando naquele cliente que passou pelo fluxo do Bot e ainda não tem cadastro na RD Station, iremos criá-lo para que possamos ter seus dados na base.

Nesta etapa, iremos usar novamente a etapa do Bot chamada “Conecte a outro sistema”, Ao invés de utilizarmos o método GET, agora iremos cadastrar uma informação na RD Station via API, portanto, vamos utilizar o método POST (Enviar uma nova informação).

A URL da RD Station deve ser inserida no campo “Com quem você quer integrar?” e em seguida Enter: https://crm.rdstation.com/api/v1/contacts

Na API da RD Station, é informado que para efetuar o cadastrado de um novo contato, será através de Body, usando estrutura em JSON da requisição.

No teste a seguir, apenas irei cadastrar o nome e email do contato,  porém caso queira cadastrar mais informações, lembre-se primeiro de perguntar em algum momento no bot, salvar a resposta e usar a estrutura da API RD Station.  É a única parte da integração que pode necessitar da ajuda de um desenvolvedor caso exista a necessidade de acrescentar mais informações que serão enviadas.

A estrutura que estou usando é a seguinte:

{

  "token": "MY TOKEN",

  "contact": {

    "name": "#nome-contato",

    "organization_id": "ID_EMPRESA",

 "emails": [

{

"email": "#email-contato"

}

],

"phones": [

{

"phone": "#tel-celular-contato"

      }

    ]

  }

}

Agora será o momento de utilizarmos o campo personalizado de pessoas que criamos na etapa 5 deste artigo, para salvarmos o ID do Contato.

Iremos selecionar o item “id” e salvar com a variável criada para a RD Station.

Caso os campos das variáveis para teste não apareçam, apague as variáveis no body e insira novamente.

A RD Station obrigatoriamente solicita o ID de um contato, para realizar a criação de um novo negócio/oportunidade, por isso, as etapas anteriores são necessárias.

Nesta etapa, iremos usar novamente a etapa do Bot chamada “Conecte a outro sistema”, no método POST (Enviar uma nova informação).

A URL para a criação da oportunidade é a seguinte: https://crm.rdstation.com/api/v1/deals

Ao inserir a URL, outros campos e abas irão aparecer para preenchimento.

Iremos preenchê-las da seguinte forma:

Na opção PARAMS:

Chave: token

Valor: Seu API Token gerado na RD Station 

Na opção BODY, iremos preencher quais informações serão enviadas a RD Station, este é um exemplo que pode ser utilizado:

{

  "contacts": [

    {

      "emails": [

        {

          "email": "#email-contato"

        }

      ],

      "phones": [

        {

          "phone": "#tel-celular-contato",

          "type": "cellphone"

        }

      ],

      "name": "#nome-contato"

    }

  ],

  "deal": {

    "name": "Oportunidade - #nome-contato ",

    "deal_stage_id": "ETAPA DO FUNIL DE VENDAS",

    "user_id": "ID DO RESPONSÁVEL / USUÁRIO"

  }

}

A estrutura acima é conhecida como BODY de requisição, ela segue alguns padrões conforme orientados na API RD Station.  É a única parte da integração que pode necessitar da ajuda de um desenvolvedor caso exista a necessidade de acrescentar mais informações que serão enviadas.

Para que você possa enviar informações adicionais em campos personalizados, para dentro da RD Station é necessário antes, toda informação ser perguntada no BOT da Octadesk e ser salva em um campo personalizado de pessoa, como ensinado no tópico 5.

Após isso, os campos precisam ser criados dentro da RD Station, e utilizar o ID que será gerado de cada campo. Como mostra abaixo.

Você pode criar campos personalizados na RD para Negociação / Empresa e Contato.

Para enviar demais informações, basta seguir os passos de cada etapa, como criar contato ou oportunidade/negociação, e usar o BODY abaixo, pois ele tem a linha de Custom Fields, que permite o envio dessas informações extra.

{

  "contact": {

    "contact_custom_fields": [

      {

        "custom_field_id": "ID DO CAMPO PERSONALIZADO DA RD CRM",

        "value": "Variável que você salvou a resposta da sua pergunta, dentro da Octadesk (#CPF-Contato ou #CNPJ-Contato)"

      }

    ],

    "emails": [

      {

        "email": "#email-contato"

      }

    ],

    "name": "#nome-contato",

    "phones": [

      {

        "phone": "#tel-celular-contato",

        "type": "cellphone"

      }

    ]

  }

}

Após sucesso na integração, ficará da seguinte forma no CRM.

Nesse exemplo, estou enviando a URL da conversa de um cliente, que foi gerada dentro da Octadesk, para dentro da oportunidade/negociação na RD CRM.

Facilitando assim para quem tem acesso a ambos sistemas, não ter que ficar procurando a conversa dentro da Octadesk, comente com o sistema aberto, usando a URL, já será direcionado para a conversa certa.

{

  "deal": {

    "deal_stage_id": "ETAPA DO FUNIL DE VENDAS",

    "name": "Nova Oportunidade",

    "user_id": "ID DO RESPONSÁVEL / USUÁRIO",

    "deal_custom_fields": [

      {

        "custom_field_id": "ID DO CAMPO PERSONALIZADO DA RD CRM",

        "value": "https://beta.octadesk.com/chat/#id-conversa/opened?inbox=all"

      },

      {

        "custom_field_id": "ID DO CAMPO PERSONALIZADO DA RD CRM",

        "value": "Variável que você salvou a resposta da sua pergunta, dentro da Octadesk (#Produto-contato)"

      }

    ]

  },

  "contacts": [

    {

      "name": "#nome-contato",

      "phones": [

        {

          "phone": "#tel-celular-contato",

          "type": "cellphone"

        }

      ],

      "emails": [

        {

          "email": "#email-contato"

        }

      ]

    }

  ]

}

Após sucesso na integração, ficará da seguinte forma no CRM