PARA DESENVOLVEDORES
Bens e direitos
na sua aplicação.
Um contrato de API para cadastrar ativos, enviar evidências, solicitar estimativas e acompanhar a revisão.
OpenAPI 3.1 ↗Estimativas com fontes integradas
Consulte GET /api/v1/asset-valuation/market/coverage para conhecer a cobertura das 18 categorias. As rotas de consulta são públicas, sem autenticação ou persistência. Decimais são strings; um resultado sem cobertura tem amount: null, nunca zero.
- Veículos:
GET /market/vehicles?type=cars, depois&brand=25e&model=7693. Use os códigos retornados. - Estimativa:
POST /market/vehicle-estimatescom{"type":"cars","brand":"25","model":"7693","year":"2020-5"}. Para motos use motorcycles; caminhões e ônibus, trucks. - Máquinas:
GET /market/equipment?family=tractorePOST /market/equipment-estimatescom family, product_code e condition. Referências de aquisição por configuração; usados podem retornar dados insuficientes. - Títulos:
GET /market/treasuryePOST /market/treasury-estimatescom product_id e quantity. - Créditos:
POST /market/credit-estimatescom asset_class, face_value e due_date. Cenário de valor presente pela Selic, sem avaliação de risco.
Todas essas rotas usam o prefixo /api/v1/asset-valuation. Valores de veículos vêm da Parallelum / FipeAPI; a FIPE não oferece API própria. Consulte exemplos e limites no contrato público atualizado.
Simulação manual opcional, sem credencial
Envie POST /api/v1/asset-valuation/public-estimates com asset_class e parameters. Não exige login, chave ou banco de dados. O cálculo usa os valores informados e não salva um ativo. Limite: 8 KB por requisição.
{"asset_class":"INVENTORY","parameters":{"quantity":"100","unit_price":"25.50","unit":"unidade"}}Retorna amount: "2550.00", currency: "BRL", basis: "USER_PROVIDED", origem e limitações. Nenhum preço automático está implícito. Consulte o contrato da API pública. Para chamadas no navegador, use a mesma origem; em outros projetos, chame pelo seu backend.
Estoque: produto e quantidade
Consulte GET /api/v1/asset-valuation/inventory/presets para listar produtos, unidades e fontes predefinidas. Envie POST /api/v1/asset-valuation/inventory/quick-estimates com apenas:
{"product_id":"deral-prp-cafe-beneficiado-produtor","quantity":"100"}O servidor usa o preço da média publicada pelo DERAL para o Paraná e retorna o total em amount, o preço por saca em unit_price, a unidade, a data e a evidência. A quantidade desse café representa sacas de 60 kg. Não é necessário preencher marca, fabricante, apresentação ou preço. Referências com mais de 21 dias ficam indisponíveis. O catálogo indica available; não use evidência histórica como preço atual. A API não supõe a localização do estoque e não ajusta o preço para outras regiões.
Estoques identificados e evidências públicas
Use GET /api/v1/asset-valuation/inventory/catalog para escolher o produto; GET /inventory/references?product_id=…&state=PR para buscar preços; e POST /inventory/estimates para calcular o lote. As duas últimas rotas usam o mesmo prefixo /api/v1/asset-valuation.
A referência inclui produto, data, unidade, região e origem. O cálculo devolve também inventory, evidence e source. O servidor recupera o preço da fonte; não aceita sobrescrevê-lo ao usar uma referência pública. Consulte os campos completos no contrato público.
Novos cenários públicos por categoria
Envie POST /api/v1/asset-valuation/market/guided-estimates com asset_class e parameters. Rebanhos usam peso vivo e cotação DERAL; ouro e prata usam cotação Gold API convertida com câmbio do Banco Central. Ativos biológicos, participações e propriedade intelectual têm cenários de fluxo. Aeronaves, embarcações e equipamentos fora do catálogo têm cenários de custo de reposição depreciado.
{"asset_class":"LIVESTOCK","parameters":{"product_id":"deral-prp-suino","heads":"100","weight_kg":"100"}}O servidor retorna amount, basis, calculation, source, evidence e limites. Cenários não são preços verificados de mercado. Use o contrato completo para os parâmetros de cada classe. Nenhuma vida útil, orçamento ou prêmio de risco é inventado. Não exige cadastro e não salva o cálculo.
API de gestão: autenticação
Envie sua credencial no cabeçalho Authorization: Bearer …. Ela precisa estar vinculada a um responsável, uma organização e seus perfis de acesso. Guarde a credencial no backend do projeto que consome a API.
Fluxo de integração
- Consulte
GET /api/v1/asset-valuation/profilespara obter campos e métodos das 18 classes. - Cadastre o bem em
POST /assets. Use a versão1.0.0do perfil. - Envie os documentos em partes, conclua o upload e acompanhe sua verificação.
- Solicite a estimativa em
POST /valuations. A resposta 202 contém os IDs da avaliação e do processamento. - Consulte
GET /jobs/{id}eGET /valuations/{id}. - Obtenha o relatório em
GET /valuations/{id}/report?format=jsonouformat=pdf.
Valores e estados
Os seis valores são objetos com amount, currency, basis, status e reason_codes. Quantidades e valores financeiros usam strings decimais: "125000.00". Um valor desconhecido é null; zero calculado é "0.00".
Requisições seguras para repetição
Envie Idempotency-Key em cada POST. A mesma chave e o mesmo conteúdo retornam a resposta anterior por sete dias. Alterações no cadastro exigem If-Match: "versão".
Imóveis e matrículas
A API imobiliária existente continua disponível. O perfil REAL_ESTATE recebe o JSON original da estimativa e mantém seu valor, data, método e limitações. A importação declarada passa pelo fluxo de evidências e revisão.
Disponibilidade das fontes
Os simuladores públicos combinam referências de mercado, fontes públicas e cenários com parâmetros do visitante, conforme a classe. A API identifica a base de cada resultado. A gestão e o reconhecimento de garantias continuam sujeitos a análise e revisão.