Para Desenvolvedores

API de QR Code

Gere QR Codes e leia a análise de escaneamentos direto do seu próprio código. A API do CodesQR é uma interface REST pequena e previsível que retorna JSON, disponível em toda conta CodesQR.

Obtenha sua chave de API Veja um exemplo

Autenticação

Toda requisição é autenticada com uma chave de API secreta enviada como bearer token. Crie uma chave a partir do seu painel em Configurações, mantenha-a no lado do servidor e nunca a exponha em código de cliente. Todas as requisições vão por HTTPS para https://api.codesqr.com.

Authorization: Bearer sk_live_your_api_key

Endpoints

POST /v1/qr

Cria um QR Code estático ou dinâmico.

GET /v1/qr/{id}

Recupera um único QR Code e as URLs da sua imagem.

PATCH /v1/qr/{id}

Muda o destino ou o título de um código dinâmico.

GET /v1/qr/{id}/stats

Lê a análise de escaneamentos de um código dinâmico.

GET /v1/qr

Lista os QR Codes da sua conta.

DELETE /v1/qr/{id}

Exclui um QR Code.

Criar um QR Code

Envie um POST para /v1/qr com o tipo e o alvo. Defina dynamic: true para obter um código editável e rastreável que você pode atualizar depois. A resposta inclui URLs de imagem PNG e SVG prontas para uso.

Requisição

curl https://api.codesqr.com/v1/qr \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "url",
    "target": "https://example.com/spring-sale",
    "dynamic": true,
    "title": "Spring Sale Poster",
    "color": { "dark": "#059669", "light": "#ffffff" },
    "format": "png"
  }'

Resposta

{
  "id": "qr_8fK2p1Qz",
  "type": "url",
  "target": "https://example.com/spring-sale",
  "dynamic": true,
  "short_url": "https://csqr.io/8fK2p1Qz",
  "image_url": "https://cdn.codesqr.com/qr/8fK2p1Qz.png",
  "svg_url": "https://cdn.codesqr.com/qr/8fK2p1Qz.svg",
  "scans": 0,
  "created_at": "2026-07-18T10:24:00Z"
}

Atualizar um código dinâmico

Como um QR Code dinâmico mantém o mesmo padrão impresso, você pode apontá-lo para um novo lugar a qualquer momento com um PATCH. Os códigos já impressos continuam funcionando, sem reimpressão necessária.

Requisição

curl -X PATCH https://api.codesqr.com/v1/qr/qr_8fK2p1Qz \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{ "target": "https://example.com/summer-sale" }'

Ler estatísticas de escaneamento

Para códigos dinâmicos, busque a análise de escaneamentos com um GET para /v1/qr/{id}/stats. Você recebe totais, um detalhamento diário e uma divisão por dispositivo que pode plotar em gráfico ou exportar.

Requisição

curl https://api.codesqr.com/v1/qr/qr_8fK2p1Qz/stats \
  -H "Authorization: Bearer sk_live_your_api_key"

Resposta

{
  "id": "qr_8fK2p1Qz",
  "total_scans": 1842,
  "unique_scans": 1310,
  "range": "last_30_days",
  "by_day": [
    { "date": "2026-07-16", "scans": 74 },
    { "date": "2026-07-17", "scans": 91 },
    { "date": "2026-07-18", "scans": 63 }
  ],
  "by_device": { "mobile": 1521, "desktop": 248, "tablet": 73 }
}

Limites de taxa e erros

A API retorna códigos de status HTTP padrão: 200 em caso de sucesso, 400 para uma requisição malformada, 401 para uma chave inválida, e 429 quando você excede o limite de taxa do seu plano. As respostas de erro incluem um code legível por máquina e uma message legível por humanos. Prefere não usar código nenhum? Você pode criar e gerenciar tudo manualmente no aplicativo, ou explorar primeiro todos os tipos de QR Code.

Pronto para construir?

Crie uma conta CodesQR gratuita, gere uma chave de API em Configurações e faça seu primeiro QR Code com uma única requisição.

Crie uma conta gratuita

Seu QR Code rastreável está a um minuto de distância

Aponte um código para qualquer link ou arquivo, acompanhe cada leitura e mude o destino sempre que precisar.

Criar meu QR Code grátis

Grátis para sempre
Sem cartão de crédito
Configuração em minutos