A integração API do Painel do Corretor possibilita a inclusão de novos leads ao Funil de Vendas do Painel do Corretor.
Como gerar minha Chave de API?
A Chave de API é uma forma segura de acessar os recursos do sistema.
- Acesse a tela de Configurações.
- Em Conta, selecione a opção Integrações;
- Na opção Chave da API selecione o botão Gerar Chave.
Guarde a chave em um local seguro e a compartilhe somente com pessoas de sua confiança.
Não será possível visualiza-la novamente.
Você pode utilizar a mesma chave em várias conexões.
Ao criar uma nova chave, as conexões estabelecidas pela chave anterior são desconectadas.
Registrando um lead
Qualquer usuário com uma chave de acesso pode registrar um novo lead.
POST /crm/negocios| Nome | Tipo | Local | Descrição |
| ApiKey | string | header | Chave de API para autenticar a requisição. |
| nome | string | body | Obrigatório. Título da negociação. Ex: "Pedro Silva #210". |
| produtoId | string | body | Código do ramo e produto. Uso opcional. |
| cidade | string | body | Informação cidade + UF. Ex: "São Paulo - SP". |
| etapa | guid | body | Código da etapa. Utiliza a etapa inicial se omitido. |
| etiquetas | string[] | body | Lista com nome das etiquetas. |
| contato | objeto | body | Dados para contato. |
| observacao | string | body | Texto livre e opcional. Aparecerá na timeline do negócio. |
Exemplo de requisição:
curl -XPOST
-H 'ApiKey: A9PdBDFe19T0ed36Wx3A7ioQfVBKXDaH7AC0kzBubkk0'
-H 'Content-type: application/json'
-d '{
"Nome":"Lead #3210 - Pedro Silva",
"produtoId":"fbb0a6e2-50c4-4078-95ff-f72805474367",
"Cidade":"São Paulo-SP",
"Etiquetas": ["saude", "pme", "fonte:parceria" ],
"Observacao": "Gostaria de cotações para São Paulo. \n00 a 18: 2 vidas \n39 a 43: 4 vidas",
"Contato":{
"Nome": "Pedro Silva",
"Email": "silva@mail.com",
"Telefones": ["11 922338787"]
}
}' 'https://api.paineldocorretor.net/api/crm/negocios'
Na validação do campo Cidade, se for fornecida somente a cidade (sem UF), o sistema procurará o registro da cidade na base de dados e:
- Se um único registro for localizado, o vinculo com UF será realizado;
- Se mais de um registro for localizado, o campo será ignorado.
- Se o valor informado não for localizado, o sistema ignora o campo sem emitir erros.