[email protected]  +55 27 99639-3419

How the PerfexAPI realy works

Sorry, English is comming…

Ao instalar e configurar a PerfexAPI voce seu Perfex irá criar algumas novas rotas para que dados sejam inseridos no Perfex de forma automatizada.

Segundo o diagrama abaixo o processo uma aplicação pode se conectar com o PerfexCRM atravéz de uma das entradas de dados passa pelas rotas criadas pela API.

1 – Os dados partem da sua aplicação preferêncial, ou de algum intermediario (como o Zapier por exemplo) e vão direto para o Perfex CRM.

2 – Para ser recebido no PerfexCRM os dados devem ser enviados para a URL fornecida pela PerfexAPI. Esta URL é Chamada de “Endpoint”, e para cada tipo de dado existe uma URL específica.

3 – O formato utilizado para enviar os dados para a PerfexAPI e chamado de webhook, e dentre os métodos possíveis utilizamos o método POST.

4 – Ao receber o POST a PerfexAPI a primeira coisa que acontece e a análise do token de segurança, a API compara os dados e permite ou nao a conexão e entrega dos outros dados.

Secura Token Perfer API
Use sempre uma palavra segura para evitar que sua API receba dados indesejados.

5 – Após a validação do token de segurança a segunda etapa é verifica se o POST enviado por alguma função de tratamento para os dados recebidos. Em caso de positivo ela irá trata os dados de acordo com a citada. Em caso negativo, segue o processo de analise e processasamento simplificado de cada endpoint.

Endpoint Leads

6.1 – O endpoint Lead permite as seguintes ações: Criar um novo contato, Atualizar um contato e/ou Solicitar dados do contato.

6.2 – Para criar um novo lead, é necessário enviar um POST com os campos que deseja alimentar. Porem para ação de criar novo lead existem certos campos que são essenciais. São eles:

  • Assigned: Quem é o proprietário do Lead
  • Source: A fonte de onde o Lead está vindo
  • Status: A qual status pertence este Lead
  • Nome: O nome pelo qual o Lead é identificado
  • Email*: O email de identificação do Lead
    *Na ausencia do email, você pode identificar o Lead pelo Telefone
  • Telefone: O numero de telefone pelo qual o Lead será identificado.

Enviando algum valor nestes campos um novo lead será criado. A Api utiliza o email como identificador único primário e o Telefone como identificador suplente. Caso ja exista no sistema algum Lead com o email apontado, ele será atualizado com os dados enviados no POST.

6.3 – Para atualizar um lead é necessário enviar um dos campos de identificação, Email ou Telefone (na ausencia do Email). E os campos que deseja atualizar. Caso o Lead enviado já possua seu email registrado no PerfexCRM a API não irá criar um novo lead. Mas irá atualizar às informações do PerfexCRM substituindo pelos dados contidos no POST.

6.4 – Para solicitar os dados de um Lead pela PerfexAPI, você deve enviar um POST contendo uma das funções de retorno e um identificador único, email ou telefone, neste caso a regra para o identificador unico continua sendo a mesma do tópico 6.2. A Lista de funções pode ser encontrada neste Link. A PerfexAPI irá retornar os dados pelo callback do endpoint da API.

7 – Os dados enviados pela PerfexAPI afetam diretamente os dados principais do Perfex CRM, as alterações realizadas não poderão ser desfeitas. E caso um lead sofra uma atualização os dados antigos serão perdidos permanentemente. Por isto configure corretamente a sua PerfexAPI em um ambiente de testes antes de colocar em produção.

SPONSOR THIS PROJECT.

Get the acesse to this API now.