API pública de QR Code em JSON

Antes de tudo: onde o conteúdo trafega

O gerador da interface do site monta o QR Code no navegador: nada do que é digitado lá chega até nós. A API é a exceção óbvia — para gerar a imagem no servidor, o conteúdo precisa viajar na requisição. Ele não é gravado em banco, aparecendo apenas no log volátil de acesso do servidor, que é rotacionado.

Consequência prática: não use a API para conteúdo sensível — chave Pix de terceiro, senha de rede corporativa, dados pessoais. Para esses casos, gere pelo navegador, na página do formato, ou rode o codificador do lado do seu servidor.

GET /api/v1/qr

Gera o símbolo e devolve a imagem pronta. É o endpoint que serve para embutir um QR Code direto no seu HTML, com uma tag <img>.

Exemplo: /api/v1/qr?texto=https://www.qrcodeja.com.br&formato=png&escala=8

GET /api/v1/analisar

Identifica o formato do conteúdo e devolve como ele se comporta nos quatro níveis de correção — versão, módulos, modo, ocupação e lado mínimo de impressão.

Exemplo: /api/v1/analisar?texto=WIFI:T:WPA;S:Loja;P:senha2026;;

GET /api/v1/pix

Monta um BR Code estático de Pix, com o CRC16 já calculado, conforme o Manual de Padrões para Iniciação do Pix do Banco Central.

Exemplo: /api/v1/[email protected]&nome=Loja%20Exemplo&cidade=Vitoria&valor=25.50

GET /api/v1/capacidade

Consulta a tabela de capacidade calculada a partir dos parâmetros da ISO/IEC 18004. Informe versao para os dados completos de uma versão, ou nivel e modo para a tabela das 40.

Exemplo: /api/v1/capacidade?versao=10

GET /api/v1/tipos

Lista os 18 tipos de QR Code documentados no site, com o formato do payload, a correção recomendada e a especificação que define cada um.

Exemplo: /api/v1/tipos

GET /api/v1/segmentos

Lista os 42 segmentos de negócio e quais formatos têm aplicação documentada em cada um.

Exemplo: /api/v1/segmentos

Exemplos de uso

Embutir um QR Code numa página

Como o endpoint devolve a imagem, ele funciona direto numa tag de imagem. Lembre de codificar o conteúdo para URL:

<img src="https://www.qrcodeja.com.br/api/v1/qr?texto=https%3A%2F%2Fexemplo.com.br&formato=png&escala=6"
     alt="QR Code do site" width="248" height="248">

Gerar em lote no terminal

while read linha; do
  curl -s "https://www.qrcodeja.com.br/api/v1/qr?texto=$(printf %s "$linha" | jq -sRr @uri)&formato=png" \
    -o "qr-$(echo "$linha" | md5sum | cut -c1-8).png"
done < lista.txt

Descobrir a versão antes de decidir o tamanho de impressão

curl -s "https://www.qrcodeja.com.br/api/v1/analisar?texto=BEGIN:VCARD..." | jq '.niveis.M'

A resposta traz ladoMinimoCm, que é o menor lado em que aquele símbolo ainda mantém módulos de 0,4 mm — o piso prático para impressão comum.

Quando usar a API e quando não usar

Usar: geração em lote (etiquetas, crachás, mesas numeradas de um salão), integração com sistema próprio (cada pedido gera um QR de Pix com valor), consulta de capacidade dentro de um validador de arte, e embutir um código estático numa página que você controla.

Não usar: conteúdo sensível de terceiros, volume acima do limite sem combinar antes, e — o mais importante — como fonte em tempo real de um material impresso. QR Code estático não precisa de servidor: gere uma vez, salve o SVG e imprima. Um <img> apontando para a nossa API dentro do seu site funciona, mas cria uma dependência desnecessária entre o seu site e o nosso.

Se o volume for grande e recorrente, o caminho mais robusto é rodar o codificador do seu lado: o arquivo qr.js deste site é servido publicamente em /qr.js, funciona em Node e no navegador, não tem dependência e implementa a norma inteira. Copie e use.

Códigos de resposta

As respostas de imagem têm Cache-Control: public, max-age=86400 — o mesmo conteúdo gera exatamente o mesmo símbolo, então cachear é seguro e economiza requisição.

Perguntas frequentes