chat_bubble

VEJA COMO UTILIZAR NOSSAS APIS

Developers

Aqui está a documentação completa das APIs disponiveis.

Veja a Documentação


API DE INTEGRAÇÃO JSON

Documentação da API - POST (JSON) - Dados de Cotação
Seguro de Veículos

Descrição

Esta API é utilizada exportar via POST as informações de uma cotação de seguro de veículos no momento da captação, utilizando parâmetros específicos. O retorno é um objeto JSON contendo os dados formatados da cotação. Esta funcionalidade está disponível somente nos planos pagos.

Exemplo de Resposta (POST JSON)

A seguir temos um exemplo da estrutura do objeto JSON postado no endpoint definido pelo usuário. Esta postagem ocorre imediatamente após a confirmação da aquisição da lead na vitrine de captação.

Json

{
    "id_cotacao": "0001",
    "ref_ext_user": "1",
    "data_captura": "09\/08\/2024",
    "tipo_veiculo": "CARRO",
    "modalidade_seguro": "SEGURO NOVO",
    "posse": "SIM",
    "seguradora_preferencia": "PORTO SEGURO",
    "valor_preferencia": "4809.11",
    "nome_segurado": "MARIA DOS SANTOS",
    "nome_social": "",
    "cpf_segurado": "66406344065",
    "data_nascimento": "10\/02\/1980",
    "estado_civil": "CASADO(A)",
    "sexo": "FEMININO",
    "proprietario": "SIM",
    "email": "EMAIL@EMAIL.COM",
    "origem": "CORRETOU",
    "telefone_celular": "11999999999",
    "logradouro": "RUA DAS FLORES",
    "numero": "123",
    "bairro": "BAIRRO DAS FLORES",
    "cidade": "HOLAMBRA",
    "uf": "SP",
    "cep": "13916434",
    "tipo_de_moradia": "CASA",
    "marca": "GM - CHEVROLET",
    "modelo": "ONIX HATCH 1.0 12V Flex 5p Mec.",
    "ano": "2023",
    "placa": "FTP1234",
    "valor_fipe": "49564.00",
    "cod_fipe": "0045195",
    "condutor_principal": "O SEGURADO",
    "ci": "00000000000000",
    "aplicativo": "NAO",
    "kit_gas": "NAO",
    "blindado": "NAO",
    "financiado": "NAO",
    "alarme": "SIM",
    "isento_imposto": "NAO",
    "jovem_condutor": "NAO",
    "uso": "LAZER (PARTICULAR)",
    "pernoite": "GARAGEM COM PORTAO"    
}

Campos do JSON e seus Tipos de Dados

Aqui está uma descrição dos tipos de dados para cada campo no JSON retornado pela API:

Campo Tipo Descrição
id_cotacao string ID da cotação.
ref_ext_user string Telefone do segurado, utilizado como referência externa.
data_captura string Data em que a lead foi capturada (formato DD/MM/AAAA).
tipo_veiculo string Tipo de veículo (ex: "CARRO", "MOTO", "CAMINHÃO").
modalidade_seguro string Modalidade do seguro (ex: "SEGURO NOVO, RENOVAÇÃO - BONUS 10").
posse string Retorna se o cliente está em posse do veículo. (ex: "SIM", "NAO").
seguradora_preferencia string Seguradora de preferência do segurado. Escolha feita no momento da simulação. Não havendo a resposta é nula.
valor_preferencia string Valor preferencial do seguro, armazenado como string formatada. (ex: 5000.00)
nome_segurado string Nome completo do segurado.
nome_social string Nome social do segurado. Não havendo a resposta é nula.
cpf_segurado string CPF do segurado. Sem pontuações (ex: "12345678900")
data_nascimento string Data de nascimento do segurado (formato DD/MM/AAAA).
estado_civil string Estado civil do segurado (ex: "CASADO(A)", "SOLTEIRO(A)").
sexo string Sexo do segurado (ex: "MASCULINO", "FEMININO").
proprietario string Indica se o segurado é o proprietário do veículo (ex: "SIM", "NAO").
email string Endereço de email do segurado. Se não informado retorna "EMAIL@EMAIL.COM"
origem string Retorna a origem de captação da lead. (ex: "CORRETOU")
telefone_celular string Telefone celular do segurado. No formato sem máscara (ex: "11999999999")
logradouro string Nome da rua ou avenida onde o segurado reside.
numero string Número da residência do segurado.
bairro string Nome do bairro onde o segurado reside.
cidade string Nome da cidade onde o segurado reside.
uf string Unidade Federativa (estado) onde o segurado reside (ex: "SP", "RJ").
cep string Código postal (CEP) do segurado. Sem máscara (ex: "12345090")
tipo_de_moradia string Tipo de moradia do segurado (ex: "APARTAMENTO", "CASA").
marca string Marca do veículo.
modelo string Modelo do veículo.
ano string Ano do modelo do veículo.
placa string Placa do veículo. Não havendo a resposta é nula.
valor_fipe string Valor da tabela Fipe do veículo, armazenado como string formatada. (ex: "45000.00")
cod_fipe string Código Fipe do veículo.
condutor_principal string Nome do condutor principal do veículo.
ci string Número do CI (Carteira de Identidade) do condutor.
aplicativo string Indica se o veículo é utilizado para aplicativos de transporte (ex: "SIM", "NAO").
kit_gas string Indica se o veículo possui kit de gás (ex: "SIM", "NAO").
blindado string Indica se o veículo é blindado (ex: "SIM", "NAO").
financiado string Indica se o veículo está financiado (ex: "SIM", "NAO").
alarme string Indica se o veículo possui alarme (ex: "SIM", "NAO").
isento_imposto string Indica se o veículo é isento de impostos (ex: "SIM", "NAO").
jovem_condutor string Indica se há um jovem condutor utilizando o veículo (ex: "SIM", "NAO").
uso string Indica a atividade de uso do veículo (ex: "LAZER", "COMERCIAL").
pernoite string Local onde o veículo passa a noite (ex: "GARAGEM COM PORTAO", "NA RUA", "ESTACIONAMENTO").

Ativação do Webhook

Para ativar o uso desta API, é necessário ajustar as configurações de Integração API (Seguro de Veículos) na sua plataforma. Siga os passos: acesse Configurações > Ferramentas, onde você encontrará dois campos importantes.

Webhook: Ative este campo caso deseje que a informação da lead seja enviada automaticamente via POST assim que for adquirida. Certifique-se de marcar a opção "Ativo".

EndPoint: Insira o endereço do EndPoint da sua aplicação para que a plataforma possa enviar o POST JSON correspondente. Após inserir o endereço, clique em "Salvar".

Importante: o POST é realizado apenas uma vez por lead, no momento da aquisição. Se ocorrer uma falha de comunicação com o seu endpoint durante essa etapa, não será possível reenviar o POST para essa lead específica. Portanto, é essencial garantir a baixa latência e a alta disponibilidade do serviço da sua aplicação. Se você já adquiriu leads antes da ativação do Webhook, não será possível realizar o POST dessas informações retroativamente.

Atenção: Seu EndPoint deve estar protegido com um certificado SSL (ex.: https://seuendpoint.com). Caso o endereço inserido não utilize SSL, a plataforma removerá o endereço automaticamente por questões de segurança. Essa verificação ocorre periodicamente.

Teste seu EndPoint

Abaixo você pode testar o funcionamento do seu EndPoint antes de ativar o Webhook em produção. Erros não são exibidos, portanto você deverá verificar em sua recepção se todos os campos estão sendo coletados por sua aplicação.

Teste de EndPoint (JSON)




Versão 1.2.7

© Copyright 2022 Corretou  - All Rights Reserved