Visão geral da API

A API REST do qr3.app está disponível em https://qr3.app/v1/.

Versionamento

A API é versionada através do caminho da URL (/v1/). Breaking changes sempre resultam em uma nova versão principal.

Formato da requisição

Content-Type: application/json
Autenticação: Authorization: Bearer qr3_sk_xxx
Idempotência: Requisições POST podem ser tornadas idempotentes com Idempotency-Key: <uuid>

Formato da resposta

Todas as respostas bem-sucedidas retornam JSON:

{
  "id": "qr_abc123",
  "type": "url",
  "url": "https://example.com",
  "short_url": "https://qr3.app/r7f3Kx",
  "created_at": "2026-03-15T10:00:00.000Z"
}

Respostas de lista sempre possuem uma estrutura meta.pagination:

{
  "data": [...],
  "meta": {
    "request_id": "req_xxx",
    "pagination": {
      "has_more": true,
      "next_cursor": "qr_abc",
      "total_count": 142
    }
  }
}

Formato de erro (RFC 7807)

Todos os erros seguem o padrão RFC 7807 Problem Details:

{
  "type": "https://docs.qr3.app/errors/not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "QR code qr_xxx not found",
  "instance": "/v1/codes/qr_xxx"
}

Status	Tipo de erro	Descrição
400	`bad-request`	JSON inválido ou campos obrigatórios ausentes
401	`authentication`	Chave de API ausente ou inválida
403	`forbidden`	Sem permissão para este recurso
404	`not-found`	Recurso não encontrado
409	`conflict`	Conflito de Idempotency-Key
422	`validation-error`	Dados de entrada incorretos (com array `errors`)
429	`rate-limited`	Limite de taxa excedido
500	`internal`	Erro interno do servidor

Paginação

A API utiliza paginação baseada em cursor:

# Erste Seite
GET /v1/codes?limit=20

# Nächste Seite
GET /v1/codes?limit=20&cursor=qr_lastid

Limites de taxa (Rate Limits)

Cada resposta contém:

X-RateLimit-Limit: 30
X-RateLimit-Remaining: 28
X-RateLimit-Reset: 1742040120

Referência interativa da API

Teste todos os endpoints diretamente no navegador:

→ Abrir Referência da API (Scalar, interativo, com Try-it-out)

DPP-Contract (Fase 4a)

Para o fluxo de trabalho de baterias, o qr3.app documenta adicionalmente estas rotas:

POST /v1/dpp
GET /v1/dpp
GET /v1/dpp/:id
POST /v1/dpp/validate
GET /v1/dpp/:id/qr.svg
GET /v1/dpp/:id/qr.png
GET /v1/dpp/:id/qr.pdf
GET /v1/dpp/:id/qr.eps
GET /01/...
GET /dpp/:gtin/:serial?lot=...

As páginas do painel, SDKs e esta documentação usam o mesmo contrato de dados.