--- title: "Base Estadual V3 Assíncrona" description: "API Base Estadual V3 Assíncrona - Respostas rápidas e pague só pelo sucesso" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/4091e178-3517-405e-b1f6-8516c042d530 markdown: https://doc.apibrasil.io/apis/creditos/4091e178-3517-405e-b1f6-8516c042d530.md source: apibrasil-documentation --- # Base Estadual V3 Assíncrona > API Base Estadual V3 Assíncrona - Respostas rápidas e pague só pelo sucesso - **Categoria:** Consultas Assíncronas - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 10,75 por consulta - **Limite:** 999.000 por mês - **Cadastro:** exige CNPJ - **Versão:** v1 - **Publicada por:** APIBrasil - **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/4091e178-3517-405e-b1f6-8516c042d530/openapi.json ⚠ Esta API ainda não atende em produção, só em homologação. ## 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 (2 endpoints) ### 1. POST /consulta/vehicles/credits API Veicular Estadual - Acesso Rápido a Créditos de Veículos A API Base Estadual V3 Assíncrona permite consultar créditos de veículos em bases estaduais com agilidade e precisão através do endpoint POST consulta/vehicles/credits. Com integração rápida ao seu sistema, você obtém respostas estruturadas e de fácil interpretação, otimizando processos como análise de crédito, compliance fiscal e gestão de ativos automotivos. Potencialize sua operação ao acessar informações essenciais para tomadas de decisão estratégicas, reduzindo custos operacionais e elevando o valor do seu negócio com dados confiáveis e atualizados em tempo real. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/vehicles/credits` - **Versão da rota:** v1 **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "base-estadual-v3-async", "placa": "ABC1234", "webhook_url": "https://webhook.site/seu-id", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/vehicles/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"base-estadual-v3-async","placa":"ABC1234","webhook_url":"https://webhook.site/seu-id","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": "820,150", "balance_before": "820,150", "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": { "accepted": true, "job-id": "a39c209e-db73-44ec-b6bf-af38a350b7fb", "msg": "consulta em processamento; resultado sera enviado ao webhook_url" } } ``` ### 2. POST /consulta/vehicles/credits API Veicular - Consulta Ágil de Créditos Estaduais A Base Estadual V3 Assíncrona permite integrar rapidamente a consulta de créditos veiculares estaduais ao seu sistema, otimizando fluxos operacionais e facilitando tomadas de decisão precisas. Com apenas um POST para o endpoint consulta/vehicles/credits, você pode acompanhar o status das requisições via Job ID, garantindo controle total do processo. O retorno detalhado da API oferece informações confiáveis para análise tributária, automação de processos financeiros e validação cadastral, agregando valor imediato ao seu negócio. Potencialize sua plataforma com consulta escalável, segura e alinhada à inovação do mercado automotivo. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/vehicles/credits` - **Versão da rota:** v1 **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "consultar-chave-base-estadual-v3", "job-id": "a39c209e-db73-44ec-b6bf-af38a350b7fb", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/vehicles/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"consultar-chave-base-estadual-v3","job-id":"a39c209e-db73-44ec-b6bf-af38a350b7fb","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. O catálogo não publica resposta de exemplo para este endpoint. 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/4091e178-3517-405e-b1f6-8516c042d530/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/4091e178-3517-405e-b1f6-8516c042d530