--- title: "Agregados V2" description: "API Agregados - Dados estratégicos em tempo real para o seu negócio" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/372a1c86-65ae-48a8-bc4b-9bd16635ab8b markdown: https://doc.apibrasil.io/apis/creditos/372a1c86-65ae-48a8-bc4b-9bd16635ab8b.md source: apibrasil-documentation --- # Agregados V2 > API Agregados - Dados estratégicos em tempo real para o seu negócio - **Categoria:** Segurança Veicular - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 0,60 por consulta - **Limite:** 990.000 por mês - **Cadastro:** exige CNPJ - **Versão:** v2 - **Publicada por:** APIBrasil - **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/372a1c86-65ae-48a8-bc4b-9bd16635ab8b/openapi.json ## Como chamar **Endereço base:** `https://gateway.apibrasil.io/api/v2` Autenticação: cabeçalho `Authorization: Bearer `. Nada além disso. Com `homolog: true` no corpo, o gateway responde de uma base fixa, com a forma real da resposta, e não cobra. O CPF 00000000000 é dessa base e não é de ninguém: use-o nos testes, nunca em produção. ## Endpoints (1 endpoint) ### 1. POST /consulta/veiculos/credits API Veicular — Consulta e Gestão Inteligente de Veículos A API Veicular oferece uma solução prática e confiável para consultar, validar e analisar informações de veículos, centralizando dados técnicos, cadastrais e de registro em uma única resposta padronizada. É ideal para anúncios automotivos, gestão de frota, processos de compra e venda e análise de risco. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/veiculos/credits` - **Versão da rota:** v2 **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "agregados-v2", "placa": "ABC1234", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/veiculos/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"agregados-v2","placa":"ABC1234","homolog":true}' ``` Este endpoint aceita `homolog: true` no corpo: a resposta volta com dados válidos, `api_limit_for` igual a `homolog` e sem tarifação. **Resposta de exemplo, do catálogo** ```json { "user": { "first_name": "[omitido]", "email": "[omitido]", "cellphone": "[omitido]", "notification": "yes" }, "balance": "106,180", "balance_before": "106,180", "tax": "0,000", "status_code": 200, "error": false, "message": "Dados validos em homologacao! Voce nao foi tarifado e a requisicao nao foi contabilizada.", "valor_consulta": 0, "api_limit_for": "homolog", "homolog": true, "data": { "anoFabricacao": "2019", "anoModelo": "2020", "caixaCambio": "Automatica", "capMaxTracao": null, "capacidadeCarga": null, "capacidadePassageiro": "5", "categoria": "AU - SUV COMPACTO", "chassi": "9BWZZZ99ZKP000000", "cidade": "CURITIBA", "cilindradas": "1399", "cmt": null, "codigoCombustivel": "FLEX", "codigoFipe": [ { "codigo": "001234-5", "valorZeroKM": null } ], "codigoMarcaModelo": "123456", "codigoMunicipio": "1234", "combustivel": "FLEX", "corVeiculo": "AZUL", "decodificadorPrecificador": { "codigoFipe": null, "versao": null }, "eixoTraseiroDif": "0", "eixos": null, "especieVeiculo": "PASSAGEIRO", "familia": "TRACKER", "marca": "CHEVROLET", "marcaModelo": "GM/TRACKER LTZ", "modelo": "TRACKER", "municipio": "CURITIBA", "nacionalidade": "NACIONAL", "numCarroceria": "0", "numMotor": "KL1PC5860LK000000", "numTerceiroEixo": "0", "pbt": null, "placa": "ABC1234", "potencia": "153", "procedencia": "NACIONAL", "registroDi": null, "tipoCarroceria": "SUV", "tipoDocFaturado": "NOTA FISCAL", "tipoDocImportadora": "NAO SE APLICA", "tipoVeiculo": "AUTOMOVEL", "uf": "PR", "ufFaturado": "PR" } } ``` Nos exemplos de resposta, os campos da conta que gerou o exemplo (`user.first_name`, `user.email`, `user.cellphone`) saem como `[omitido]`. O resto é o que o catálogo publica. ## Armadilhas: o que uma integração erra sem avisar Apuradas nas respostas que o próprio catálogo publica. Em todas elas o código funciona no caminho feliz e falha em silêncio no resto: 1. **O erro chega no CORPO, com HTTP 200.** A resposta traz um campo `error` booleano e uma `message`. Checar só `response.ok` ou o status HTTP deixa passar falha como sucesso. Confira SEMPRE `error === false` antes de ler `data`. 2. **`balance`, `tax` e `extra_charges.total` são STRING em formato brasileiro — e o formato varia entre APIs.** Valores observados no catálogo: `"154,380"`, `"497,84"`, `"0,000"` e `"0.19"`. Vírgula em umas, ponto em outra; três casas decimais em umas, duas em outra. Em JavaScript, `parseFloat("154,380")` devolve `154` e perde os centavos sem erro nenhum, e `Number("154,380")` devolve `NaN`. Escreva um conversor que trate os dois separadores, e nunca use esses campos numa decisão financeira sem convertê-los. 3. **Cada chamada custa dinheiro.** Retry cego multiplica a conta. Nunca repita automaticamente um 4xx: parâmetro errado repetido continua errado e continua cobrando. Repita só tempo esgotado e 5xx, com recuo exponencial e um teto pequeno de tentativas. 4. **HTTP 402 é saldo insuficiente, e repetir não resolve.** É o único status que exige ação humana — recarregar. Trate-o como erro terminal, com mensagem própria, e não o jogue no mesmo balde dos 4xx genéricos. 5. **`extra_charges` cobra à parte do preço da consulta.** Quando o corpo pede serviços adicionais, a resposta traz cada um com o preço e um `total` que NÃO está incluso no valor base. Se você mostra custo a quem usa, some os dois. ## Ver também - Especificação OpenAPI: https://doc.apibrasil.io/apis/creditos/372a1c86-65ae-48a8-bc4b-9bd16635ab8b/openapi.json - Catálogo de APIs: [Catálogo de APIs](https://doc.apibrasil.io/apis.md) - SDKs oficiais: [SDKs oficiais](https://doc.apibrasil.io/sdks.md) - Índice da documentação: https://doc.apibrasil.io/llms.txt - Versão HTML desta página: https://doc.apibrasil.io/apis/creditos/372a1c86-65ae-48a8-bc4b-9bd16635ab8b