QRCode Suiteplataforma QR
Desenvolvedores

API de QR code para desenvolvedores

O QRCode Suite oferece uma API REST versionada na plataforma: crie QR codes, altere destinos e consulte as análises de leituras com o mesmo mecanismo do painel. A autenticação usa chaves de API com escopos, criadas no painel. A API também registra conversões em /api/v1/conversions, envia webhooks assinados com HMAC para leituras e leads de formulário e disponibiliza um pixel JavaScript para as conversões no seu site.

Acesso à API incluído nos planos Business e Agency.

Começar grátis →Ver preços

Endpoints CRUD da API de QR code

Liste e crie QR codes em /api/v1/qrcodes; consulte, atualize e exclua um código específico em /api/v1/qrcodes/:id. Alterar destination_url ou status via PATCH vale já na próxima leitura — o código impresso nunca muda.

Chaves de API com escopo

Gere chaves de API no painel apenas com os escopos de que elas precisam — qrcodes:read, qrcodes:write, scans:read, conversions:write. Cada chave tem limite de 300 requisições por minuto na API REST, mais um limite separado de 300 por minuto para conversões, e fica vinculada a um único espaço de trabalho; mantenha-a no servidor.

Dados de leitura pela API

Percorra, página por página, os eventos de leitura em /api/v1/scans, filtrados por qr_id e por um número de dias: dispositivo, país, referenciador e data e hora — os mesmos dados, com privacidade em primeiro lugar, que o painel exibe em gráficos, sem IPs brutos em lugar nenhum.

API de conversões

Envie eventos de compra e de cadastro via POST para /api/v1/conversions com um event_name, um external_id para evitar duplicidades, um valor e uma moeda opcionais e o qr_slug que trouxe o cliente, para atribuir a receita à leitura.

Webhooks

Inscreva endpoints em qr.scanned (cada leitura real, sem bots) e qr.lead_captured (cada lead de formulário hospedado). As entregas são assinadas com HMAC e reenviadas com intervalos crescentes em caso de falha.

Pixel JavaScript

Um pixel leve (/pixel.js) envia as conversões no site para /api/collect e as associa à leitura de QR code que trouxe o visitante, por meio de uma referência de atribuição própria (o parâmetro qr_ref no link de destino, armazenado no localStorage do seu site). Sem impressão digital do navegador; com a opção “Não rastrear” (Do Not Track) ativada, ele envia a conversão sem nenhuma propriedade personalizada; e segue o modelo de privacidade da plataforma, que não armazena IP bruto.

Os endpoints na prática

Requisições e respostas em JSON, autenticadas com chave de API Bearer.

curl -X POST https://qrcode-suite.com/api/v1/qrcodes \
  -H "Authorization: Bearer $QRCS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "dynamic_url",
    "name": "Spring packaging insert",
    "destination_url": "https://example.com/spring-landing"
  }'
# Re-point a printed code — no reprint needed
curl -X PATCH https://qrcode-suite.com/api/v1/qrcodes/$QR_ID \
  -H "Authorization: Bearer $QRCS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "destination_url": "https://example.com/summer-landing" }'
curl -X POST https://qrcode-suite.com/api/v1/conversions \
  -H "Authorization: Bearer $QRCS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "event_name": "purchase",
    "external_id": "order-1042",
    "amount": 49.90,
    "currency": "EUR",
    "qr_slug": "k7Qm2x"
  }'

Gerar a imagem em PNG ou SVG

GET /api/qr/:slug retorna a imagem legível de um código que você criou: ?format=png ou ?format=svg, e ?size= em pixels (400 por padrão). Para impressão, ?dpi= (150, 300, 600 ou 1200) com ?mm= gera um arquivo com essa largura física em milímetros, com a densidade gravada no PNG para que o software de diagramação o posicione no tamanho certo. A extensão do arquivo segue o que foi realmente gerado: um design que o rasterizador não consegue achatar é retornado em SVG e identificado como tal. O endpoint não exige chave de API — a imagem não revela nada além do slug já impresso no código — e tem limite de requisições por IP em hash. Ele só gera códigos que existem em um espaço de trabalho; não é um gerador anônimo.

# Screen image — no API key needed
curl -o insert.png "https://qrcode-suite.com/api/qr/k7Qm2x?format=png&size=600"

# Print file: 25 mm wide at 300 DPI
curl -o insert-print.png "https://qrcode-suite.com/api/qr/k7Qm2x?format=png&dpi=300&mm=25"

Você usa o plugin para WordPress?

O plugin para WordPress tem suas próprias rotas REST no seu site, em /wp-json/qrcode-suite/v1/, autenticadas com chaves criadas na administração do plugin (Authorization: Bearer ou X-API-Key). Ele também adiciona o comando WP-CLI wp qrcs com create, scan-stats, bulk-export, webhook-test e label-generate. Essas rotas atuam sobre os códigos armazenados no WordPress; a API da plataforma acima atua sobre o seu espaço de trabalho. Ao conectar o site à plataforma (opcional), seus códigos, os totais diários de leituras e as conversões do WooCommerce passam a aparecer no seu painel.

Perguntas frequentes

O que é o QRCode Suite?

O QRCode Suite é uma plataforma QR independente: crie uma conta gratuita e gere códigos QR dinâmicos e personalizados no browser — sem precisar de WordPress. Os conectores levam os mesmos códigos ao WordPress e ao WooCommerce, onde os pedidos podem ser atribuídos a códigos QR específicos.

O QRCode Suite funciona sem WordPress?

Sim. O QRCode Suite é um SaaS independente: registe-se, crie códigos QR e acompanhe as leituras inteiramente em qrcode-suite.com. O plugin WordPress é um conector opcional que traz os seus códigos para o wp-admin e adiciona a atribuição de encomendas WooCommerce.

O QRCode Suite exige uma subscrição separada?

O plano Free está disponível sem custos — sem cartão de crédito. Os planos pagos (Pro 9 €, Business 29 €, Agency 79 € por mês) desbloqueiam códigos ilimitados, regras de redireccionamento e mais. Não existe taxa por leitura.

Que tipos de códigos QR suporta o QRCode Suite?

O QRCode Suite suporta 22 tipos de códigos QR: URL estático, URL dinâmico, Texto simples, Telefone, Email, Localização, Link Hub, SMS, WhatsApp, Wi-Fi, vCard, Perfil social, PDF, Descarga de ficheiro, Descarga de app, Cupão, Evento de calendário, Formulário de captação de leads, Recolha de avaliações, Pedido grossista, Recompensa de fidelidade e Payload personalizado.

Posso alterar o destino de um código QR depois de o imprimir?

Sim. Os códigos QR dinâmicos usam um URL de redireccionamento curto. Pode actualizar o destino a partir do seu painel a qualquer momento, sem gerar ou imprimir novamente o código.

O QRCode Suite é conforme com o RGPD?

O QRCode Suite foi concebido a pensar no RGPD: nunca são guardados endereços IP em bruto — os visitantes são contados com hashes com chave —, o tráfego de bots é filtrado automaticamente e os eventos de digitalização são eliminados quando termina a janela de retenção do seu plano. Consulte a sua equipa jurídica para as obrigações específicas.

Desenvolva com a API do QRCode Suite

Chaves de API com escopos e endpoints REST — incluídos a partir do Business.

Ver plano BusinessLer a documentação