Referência da API

A API REST do qr3.app está disponível em https://qr3.app/v1/ e segue consistentemente as convenções da Visão Geral da API (autenticação via Authorization: Bearer, erros de acordo com a RFC 7807, paginação por cursor).

Introdução

Visão Geral da API Versão, formato de requisição/resposta, idempotência, paginação.

Autenticação Chaves de API, cabeçalhos de workspace, ambiente de teste vs. produção.

Referência de Erros Tipos de erro RFC 7807 com códigos de status e exemplos.

Referência Interativa OpenAPI 3.1 + Scalar-Playground — insira tokens e teste diretamente.

Áreas de Recursos

QR Codes Criar, atualizar, rastrear e redirecionar com segurança códigos dinâmicos e estáticos.

Organizações & Workspaces Contas, workspaces, membros e limites de planos.

Webhooks Assinar eventos, verificação de assinatura, logs de entrega.

MCP & Agentes Model Context Protocol — gerar QR Codes e DPPs a partir de agentes de IA.

Proteção de Dados & Endpoints de Privacidade Exportação RGPD (GDPR), exclusão de contas, hashing de IP, consentimentos.

Versão & Depreciação Como novos campos são introduzidos e o que causa alterações incompatíveis (breaking changes).

Endpoints específicos de DPP

Todos os endpoints do Passaporte Digital do Produto estão documentados na sua própria seção Passaporte Digital do Produto — incluindo referências de esquema para baterias e têxteis, validador de conformidade da UE e o resolvedor público GS1.

URLs Base por Ambiente

Ambiente	URL Base	Finalidade
Production	`https://qr3.app/v1/`	API pública em produção
Stage	`https://qr3-api-stage.<account>.workers.dev/v1/`	Piloto de pré-produção (consulte `ENVIRONMENTS.md`)
Local	`http://localhost:8787/v1/`	`pnpm --filter api dev`

A especificação OpenAPI está disponível em https://qr3.app/v1/openapi.json e é atualizada automaticamente a cada deploy.