Enriquecimento de Placas
Nesse artigo você irá aprender como:
- O que é o Enriquecimento de Placas?
- Por que usar o Enriquecimento de Placas?
- Como funciona o Enriquecimento de Placas da Celcoin?
Pré-requisitos para implementação
- Possuir uma chave api da Celcoin, para mais informações acessar esse link
- Ter familiaridade com o padrão REST usando o protocolo OAuth 2.0.
- Ter o produto/solução de Enriquecimento de Placa, contratado e habilitado em produção.
- Caso queira usar a funcionalidade em ambiente produtivo, por favor entre em contato com a nossa equipe comercial através do e-mail [email protected]. Para dúvidas técnicas, basta entrar em contato com o suporte através do link.
O que é o Enriquecimento de Placas?
Através da Placa do Veículo, essa funcionalidade permite que sejam identificados informações básicas dos veículos, como: Estado, Renavam, Documento do Proprietário, Modelo, Cor e Ano de Fabricação. Com esses dados em mãos é possível realizar Consultas de Débitos nos órgãos competentes e saber se o veículo possui alguma pendência em aberto.
Por que Usar o Enriquecimento de Placas?
Utilizando o Enriquecimento de Placas, você garante mais assertividade e confiança nos dados do veículo, uma vez que seu usuário não precisa informa-los, fazendo com que as consultas de Débitos Veiculares sejam bem sucedidas.
Além disso, o Enriquecimento de Placas, trás um melhor desempenho, escalabilidade e melhorias operacionais no dia a dia.
Como funciona o Enriquecimento de Placas da Celcoin?
Na API da Celcoin, essa funcionalidade está disponível na chamada de Consulta Enriquecida. A seguir segue manual de como utilizar essa API.
Modelo de requisição do Enriquecimento de Placas
curl --location --request POST 'https://sandbox.openfinance.celcoin.dev/vehicledebtsapi/v1/enrichment/getdata' \
-H 'accept: application/json' \
-H 'Authorization: Bearer acess_token' \
-H 'Content-Type: application/json-patch+json' \
-d '{
"licensePlate": "KXS6161",
"clientRequestId": "{{$guid}}"
}'
Os dados informados no modelo de requisição são somente de exemplo.
Tabela Descritiva dos Campos da Requisição:
uf | Estado da placa consultada | String | True |
---|---|---|---|
licensePlate | Placa do Veículo | String | True |
clientRequestId | Identificador da transação, pode ser um ID interno da transação | String | True |
Modelo de retorno
{
"errorCode": "000",
"message": "Veículo Encontrado",
"vehicle": {
"status": true,
"uf": "MG",
"licensePlate": "KXS6161",
"renavam": "217788721",
"document": "00201022713",
"model": "TOYOTA/COROLLA XEI20FLEX",
"year": "2011",
"color": "Azul"
},
"enrichmentId": "d5ee5597-185b-4589-ac72-3afaf92ada26"
}
O documento do proprietário só é retornado nos estados do RJ, PE e PR onde esse dado é obrigatório para realizar a Consulta de Débitos.
Caso não seja possível retornar algum dado, esse campo pode assumir o valor null.
Tabela Descritiva dos Campos de Retorno:
Campo | Descrição | Tipo |
---|---|---|
status | Indica se a UF do Veículo está ativo na Celcoin | Boolean |
uf | Estado do Veículo | String |
licensePlate | Placa do Veículo | String |
renavam | Registro Nacional de Veículos Automotores do Veículo | String |
document | CPF/CNJP do proprietário do Veículo | String |
model | Marca e Modelo do Veículo | String |
year | Ano do Veículo do Veículo | String |
color | Cor do Veículo | String |
enrichmentId | Identificador da Consulta de Enriquecimento de Placas | String |
A API de Enriquecimento de Placas é Síncrona, não havendo necessidade de cadastrar um novo webhook. O resultado da consulta é retornado momentos após a solicitação.
Tabela Descritiva dos Erros Retornado
Mensagem do Erro | Código do Erro | Resolução |
---|---|---|
Consulta indisponível. | 804 | Quando esse erro ocorrer, você deve aguardar, pois o produto pode estar passando por uma instabilidade momentânea. |
Veículo não localizado | 806 | Ao realizar a consulta enriquecida, não foi encontrado o veículo informado na base de dados. |
Campo licensePlate inválido | 809 | Informe uma placa correta |
Verifique se o tipo do campo está no formato correto e tente novamente. | 809 | Verifique os dados informados na requisição. |
Produto não liberado. | 900 | Entre em contato com o suporte caso tenha o produto contratado. Caso não tenha, consulte nossos consultores de venda. |
Updated 4 months ago