API REST
Os dois endpoints da API REST do Minha CNH — criar e consultar relatórios de CNH — com entrega via webhook HMAC-SHA256 ou polling.
A integração server-to-server. Você enfileira um relatório com um POST e recebe o resultado por
webhook ou por polling, em ~5 minutos. Cobrança e limites vêm da Plataforma e
são idênticos aos do Servidor MCP. Autenticação é da API key da organização — veja
Autenticação; um token OAuth do MCP não autentica esta API.
Endpoints
| Método | Rota | O que devolve |
|---|---|---|
POST | /api/v1/reports | O reportId do relatório enfileirado — Criar relatório |
GET | /api/v1/reports/{reportId} | O status e, quando pronto, o diagnóstico — Consultar relatório |
Os dois exigem Authorization: Bearer <token>. A especificação OpenAPI interativa (Scalar) está em
/api/docs.
Por onde começar
| Etapa | O que você vai fazer |
|---|---|
| 1. Primeira chamada | Fazer o primeiro POST /api/v1/reports e receber o resultado |
| 2. Webhooks | Receber o diagnóstico sem polling, com assinatura HMAC-SHA256 |
| 3. Montar a UI | Transformar o payload em tela — campo por campo, com o relatório ao vivo |
| 4. Erros | O catálogo de erros HTTP e o tratamento recomendado |
Ainda não tem uma chave?
O acesso é habilitado manualmente pelo time Minha CNH após aprovação comercial. Veja Contratar a API.
O que não está aqui
O formato do relatório, a idempotência por externalRef, os rate limits e a cobrança não são
específicos do REST — valem igual no Servidor MCP e moram em
Plataforma.