§DEVELOPERS
Como integrar a geração de QR na sua aplicação?
A API REST do codigo-qr.es gera QR estáticos e dinâmicos, os gerencia e retorna imagens PNG ou SVG de qualquer linguagem com uma única chamada.
Requer plano Pro
Posso usar a API sem me registrar?
Sim. O endpoint público gera QR estáticos sem conta e sem API key, com limite de 50 requisições por dia por IP.
Use POST /api/v1/qr/render com o conteúdo do QR, o formato e o tamanho. Você recebe a imagem em base64. Sem registro, sem cartão.
Exemplo sem autenticação
curl -X POST https://codigo-qr.es/api/v1/qr/render \
-H "Content-Type: application/json" \
-d '{"value":"https://yourdomain.com","format":"png","size":512}'Como funciona a autenticação da API?
A API Pro usa API keys no header Authorization. A key é gerada em /panel/conta e é exclusiva do plano Pro ativo.
Adicione o header Authorization: Bearer com seu token em cada requisição Pro. A key é gerada no /panel/conta com um clique e pode ser revogada a qualquer momento.
Exemplo com API key
curl https://codigo-qr.es/api/v1/qr \
-H "Authorization: Bearer cqr_your_token_here"A API key requer plano Pro ativo. Ver planos e preços
Quais endpoints tem a API de QR?
Oito endpoints: um público sem auth para geração imediata, e sete Pro para criar, listar, atualizar, deletar, baixar imagem e ver estatísticas.
| Método | Rota | Para que serve | Plan |
|---|---|---|---|
| POST | /api/v1/qr/render | Gera um QR e retorna a imagem em base64. Sem auth. | Público |
| GET | /api/v1/qr | Lista todos os seus QR com paginação. | Pro |
| POST | /api/v1/qr | Cria um QR estático ou dinâmico. | Pro |
| GET | /api/v1/qr/{id} | Retorna os detalhes completos de um QR. | Pro |
| PATCH | /api/v1/qr/{id} | Atualiza o destino, o nome ou o status. | Pro |
| DELETE | /api/v1/qr/{id} | Exclui um QR (exclusão suave, reversível). | Pro |
| GET | /api/v1/qr/{id}/image | Baixa a imagem PNG ou SVG do QR. | Pro |
| GET | /api/v1/qr/{id}/stats | Estatísticas de escaneamentos por dia e por país. | Pro |
Para que se usa a API de QR num negócio?
E-commerce, restaurantes, eventos e logística a usam para automatizar a geração de QR em documentos e sistemas sem intervenção manual.
E-commerce
O ERP gera um QR por nota fiscal com o link de rastreamento. Se a URL mudar, PATCH atualiza o destino sem reimprimir o código.
Restaurantes
O PDV cria um QR por mesa ao abrir o turno. O chef atualiza o cardápio no CMS; o QR sempre redireciona para a versão atual.
Eventos
O sistema de ingressos gera um QR único por ingresso. Na entrada, o scanner verifica o QR via API e confirma se é válido.
Logística
Cada pacote tem um QR apontando para sua página de rastreamento. Os escaneamentos ficam em GET /api/v1/qr/{id}/stats.
Quantas requisições a API de QR permite?
O endpoint público aceita 50 requisições por dia por IP. Os endpoints Pro permitem 60 requisições por minuto por usuário com API key.
Quando você excede o limite a API retorna 429 com os headers X-RateLimit-Limit, X-RateLimit-Remaining e Retry-After para saber quando tentar novamente.
Público
50
req / day / IP
Pro
60
req / min / user
Perguntas freqüentes sobre a API de QR
O endpoint público é gratuito, limitado a 50 requisições por dia por IP. A API completa, com API key, CRUD, imagem e estatísticas, requer plano Pro a €5,99/mês.
PNG e SVG. Use o parâmetro format=png ou format=svg. Os tamanhos disponíveis são 256, 512 e 1024 pixels.
Sim. PATCH /api/v1/qr/{id} atualiza a URL de destino a qualquer momento. O QR impresso permanece o mesmo; só muda o destino.
Apenas o hash SHA-256 é armazenado, nunca o token em si. Exibido uma vez ao gerar. Você pode revogar em /panel/conta a qualquer momento.
Ainda não. A API é REST padrão e funciona com qualquer cliente HTTP: curl, fetch, axios, requests do Python, Guzzle do PHP e similares.
Comece a integrar a API de QR hoje
Crie sua conta, ative o plano Pro e gere sua primeira API key em menos de 2 minutos.