Como fazer uma Integração no Pcontrol via API?

Este tutorial mostra o passo a passo de como fazer uma integração com o Pcontrol via API.

Siga com atenção cada passo para fazer com que um contato seja enviado para o Pcontrol.

1 – No menu superior acesse o menu configurações (ícone de engrenagem) e então clique no link Integração.

2 – No módulo Integrações, clique no botão verde Cadastrar para cadastrar uma nova integração com o Pcontrol.

3 – No tela de seleção de do tipo de integração,  escolha a opção “API”.

4 – Na tela seguinte, digite um nome para a interação preenchendo o campo “Nome Integração API“. O campo “Status” deve estar como “Ativo” para que a integração aconteça e o restante dos campos devem ser preenchidos de acordo com a sua estratégia de vendas.

Após preencher todos os campos, revise-os e então clique no botão verde Salvar localizado no final do formulário.

4 – Após o cadastro ser realizado você será redirecionado à tela inicial das integrações. Confira a lista de integrações se a integração foi cadastrada corretamente.

Perceba que há um botão branco, com ícone de olho, Ver Código da Integração. Por favor, clique no botão.

5 – Clicando no botão Ver Código da Integração, será exibido o código JSON que deverá ser utilizado no sistema de interação e também o endereço de Endpoint que deverá ser utilizado.

6 – Vamos utilizar o Postman, plataforma de testes de API para desenvolvedores, para continuar como nosso tutorial. (Você pode escolher outra plataforma de testes de API como o Insomnia, por exemplo).

Independente de qual plataforma de testes de API você escolher, faça as configurações básicas da plataforma antes de continuar este tutorial.

No Postman, cole o código JSON gerado pelo Pcontrol para ser usado como Corpo da requisição.

7 – Se atente a 3 informações importantes:

• Método da requisição deve ser: POST
• URL (endpoint) de envio da requisão é: https://pctrl.com.br/lead/cadastrar
• No corpo da requisição é obrigatório ter o campo: pagina (código página está na tela de integração no Pcontrol).

OBS.: Se você copiou o código JSON gerado pelo Pcontrol, o código da página já virá preenchido corretamente.

8 – Após seguir fielmente as instruções do passo anterior, envie a requisição através sua plataforma de testes de API:

A mensagem “Cadastro realizado com sucesso” e o “Status Code 201” devem ser exibidos.

9 – Voltando ao Pcontrol, no menu superior clique em Oportunidades e então em Lista de Oportunidades.

10 – Desça a tela da lista de oportunidade até encontrar o contato que acabamos de cadastrar via integração.

Repare que na coluna “Empresa/Contato” está o nome do contato e na coluna “Origem” está o nome da Integração cadastrada.

POSSÍVEIS MENSAGENS DE ERRO

11 – Se no corpo da requisição não foi enviado o parâmetro pagina a mensagem “Código da página não encontrado.” e Status Code 400 serão exibidos

12 -Se no corpo da requisição o parâmetro pagina foi enviado em branco a mensagem “Código da página não encontrado.” e Status Code 400 serão exibidos.

13 – Se no corpo da requisição o parâmetro pagina for enviado com um código diferente do que gerado pelo Pcontrol a mensagem “Integração não encontrada.” e Status Code 404 serão exibidos.

14 – Se todos os critérios de envio de uma requisição estiver corretos porém a integração está inativa no Pcontrol a mensagem “Integração inativa.” e o Status Code 404 serão exibidos.

15 – Para verificar o status da Integração acesse o Pcontrol e na tela de integrações e veja na coluna Status o status atual da integração desejada.

16 – Caso a mensagem “Conta Pcontrol inativa ou não encontrada.” com o Status Code 404 sejam exibidos, isto significa que o acesso à sua Pcontrol está inativo.

Neste caso, entre em contato com a equipe de atendimento do Pcontrol para entender o motivo.

17 – Caso necessário, há alguns campos extras que podem ser enviados, os campos são:
● cnpj
● razao_social
● celular

IMPORTANTE:

Todas as mensagens de retorno da API (de sucesso e de erro) devem ser tratadas pelo cliente, o Pcontrol só irá realizar o cadastro de contato se todas as regras apresentadas neste tutorial estiverem validadas, caso contrário uma mensagem de erro com o status code correspondente será retorno ao cliente.

Observações:

• Caso sejam realizadas várias tentativas de  cadastro de um mesmo CNPJ, será retornado erro conforme abaixo:
• Caso sejam realizadas mais de 30 requisições dentro de 1 minuto, será exibida mensagem de erro, conforme a imagem:

Caso a mensagem de erro seja exibida, será necessário aguardar 1 minuto para realizar novas requisições.