Integração - Moskit

1 - Acessar a documentação de API do Moskit;

2 - Gerar API TOKEN dentro do Moskit;

3 -Verificar ID do Responsável (user_id) (createdBy / Responsible) dentro do Moskit;

4 - Criar um campo personalizado de números no Octadesk ;

5 - Construir um Bot que capture informações ;

6 - Verificar se já existe um contato no Moskit;

7 - Usar regra de validação para direcionamento quando contato não existir na Moskit;

8 - Cadastrar o contato gerado pelo Bot no Moskit;

9 - Verificar etapa do funil, para criar oportunidade/negócio;

10 - Criação de oportunidade/negócio no Moskit;

Link da documentação de API do Moskit: https://moskit.stoplight.io/docs/api-v2/6a456d10b1b93-consideracoes-iniciais

A documentação de API é um tutorial detalhado sobre como fazer integrações, a usaremos para encontrar as informações necessárias para realizar a integração.

A criação do API Token serve como a chave de acesso que vamos utilizar quando iniciarmos a integração. Basta ir até Marketplace>> API Pública e gerar ApiKey  como mostra o GIF abaixo:

Nessa etapa, iremos localizar o ID do Responsável, ou seja, o ID do usuário. Esse mesmo ID será utilizado nos campos de createdBy / Responsible.

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

Para visualizar esta opção:

- Acesse sua conta no Moskit;

- Clique em "Configurações";

- Clique em "Equipes";

- Clique nos 3 pontos do lado direito, e ver ativos;

- Clique em cima do usuário que será utilizado, o ID está na URL como mostra abaixo.

O campo personalizado é onde iremos salvar o ID do Moskit, e  utilizá-lo na integração. 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.

Para que a integração com a Moskit funcione corretamente, temos que ter informações dos clientes, e essas informações precisam ser perguntadas 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 Moskit.

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 Moskit para efetuar uma consulta, vamos realizar uma requisição do tipo POST, geralmente usamos o POST para efetuar cadastro, porém a documentação do CRM exige que a busca seja feita dessa forma, por isso ressaltamos a importância de ler a documentação.

Na integração do Moskit, diferente de outros CRM, podemos consultar não apenas email, mas telefone e nome, para saber se o cadastro já é existente no CRM.

Para fazer essa requisição, basta usar a URL abaixo:

https://api.moskitcrm.com/v2/contacts/search

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

Iremos preenchê-las da seguinte forma:

Na opção HEADER:

Chave: Accept

Valor: application/json

Cadastre mais um parâmetro e preencha:

Chave: Content-Type

Valor: application/json

Cadastre mais um parâmetro e preencha:

Chave: apikey

Valor: Seu API Token gerado no Moskit

Na opção BODY, iremos preencher quais informações serão buscadas no Moskit, este é um exemplo que pode ser utilizado:

Nele irei consultar o telefone, para saber se já existe cadastrado no CRM, caso deseje utilizar outra forma de busca, basta seguir o BOT da documentação, clique aqui!

[

  {

    "field": "phones",

    "expression": "like",

    "values": [

      "#tel-celular-contato"

    ]

  }

]

Após realizar a configuração acima, um campo de valide sua integração será apresentado, iremos preenchê-lo com um telefone para verificar se ele existe no Moskit, vinculado a um contato.

Importante ressaltar que a integração retornará os dados do Contato caso ele exista e retornará em branco caso ele não exista. 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 Moskit retornou em campos do Octadesk. Agora será o momento de utilizarmos o campo personalizado de pessoas que criamos na etapa 3 deste artigo, para salvarmos o ID do Contato.

Iremos selecionar o item “0.id”.

Ele representa o ID do Contato cadastrado lá no Moskit e, fazer com que essa informação seja salva vai nos permitir diferenciar contatos que existem no Moskit, dos contatos que não existem, afinal, se ele não existir a integração não retornará dado algum e o campo ID Moskit 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 Moskit, se ele foi preenchido, usando a regra “Estiver Vazio”.

Ao configurar o Bot para validar se o campo ID Moskit 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 no Moskit com o e-mail que usamos para validar a integração, portanto será necessário cadastrar esse cliente na Moskit.

- Se a regra não for válida: Significa que um existe um contato cadastrado no Moskit com o e-mail que usamos para validar a integração, portanto, não precisamos cadastrá-lo novamente.

Pensando naquele cliente que passou pelo fluxo do Bot e ainda não tem cadastro na Moskit, 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”, vamos utilizar o método POST.

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

A URL para a criação do contato é a seguinte: https://api.moskitcrm.com/v2/contacts

Essa parte da integração você pode necessitar da ajuda de um desenvolvedor caso exista a necessidade de acrescentar mais informações que serão enviadas.

Na opção HEADER:

Chave: Accept

Valor: application/json

Cadastre mais um parâmetro e preencha:

Chave: Content-Type

Valor: application/json

Cadastre mais um parâmetro e preencha:

Chave: apikey

Valor: Seu API Token gerado no Moskit

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

{

  "createdBy": {

    "id": USER ID - ID DO RESPONSÁVEL

  },

  "responsible": {

    "id": USER ID - ID DO RESPONSÁVEL

  },

  "name": "#nome-contato",

  "phones": [

    {

      "number": "#tel-celular-contato"

    }

  ],

  "emails": [

    {

      "address": "#email-contato"

    }

  ],

  "source": "MOSKIT_API_V2"

}

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

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

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

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 Moskit para efetuar uma consulta, vamos realizar uma requisição do tipo GET.

Para fazer essa requisição, basta usar a URL: https://api.moskitcrm.com/v2/deals

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

Iremos preenchê-las da seguinte forma:

Na opção HEADER:

Chave: Accept

Valor: application/json

Cadastre mais um parâmetro e preencha:

Chave: apikey

Valor: Seu API Token gerado no Moskit

O ID é ID da etapa do funil de vendas que deseja.

Mais abaixo, você consegue consultar o nome da etapa.

Esse ID será necessário para a criação da oportunidade, que veremos na próxima etapa.

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

Para fazer essa requisição, basta usar a URL: https://api.moskitcrm.com/v2/deals

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

Iremos preenchê-las da seguinte forma:

Na opção HEADER:

Chave: Accept

Valor: application/json

Cadastre mais um parâmetro e preencha:

Chave: Content-Type

Valor: application/json

Cadastre mais um parâmetro e preencha:

Chave: apikey

Valor: Seu API Token gerado no Moskit

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

{

  "email": "#email-contato",

  "status": "OPEN",

  "source": "MOSKIT_API_V2",

  "stage": {

    "id": ETAPA DO FUNIL DE VENDAS

  },

  "createdBy": {

    "id": USER ID - ID DO RESPONSÁVEL

  },

  "responsible": {

    "id": USER ID - ID DO RESPONSÁVEL

  },

  "name": "#nome-contato",

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

  "contacts": [

    {

      "id": "#idmoskitnumero-contato"  

    }

  ]

}

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