QR Codes

Operações

Conteúdo por tipo

Textos: até 2048 caracteres. vCard exige pelo menos um campo preenchido. Listas de vCard: até 20 itens, até 1024 caracteres cada; vcard_social_label e vcard_social_value precisam ter o mesmo tamanho. Datas de evento: YYYY-MM-DDTHH:mm, com fuso IANA em event_timezone. Para QR dinâmico de URL, informe link_id com o UUID de um link da conta; seu endereço será usado automaticamente.

Integrações antigas: text, phone, location, event e crypto continuam aceitos como aliases dos tipos atuais. style, inner_eye_style e outer_eye_style correspondem a pattern, marker_in e marker_out; square vira default e round vira rounded. Use os nomes atuais em novas integrações.

Personalização comum a todos os tipos

Cores usam #RRGGBB. Transparência: 0 = opaco, 100 = transparente. custom_eyes_color ativa cores dos olhos; different_eyes_color ativa cores diferentes por posição. harmonize_background depende de use_image_background. remove_margin remove a margem somente sem moldura. Use size de 200 a 800, em passos de 100. A aparência não garante leitura: valide o resultado em celulares antes de imprimir.

wifi_encryption: nopass, WEP, WPA/WPA2

crypto_coin: bitcoin, ethereum, elrond

paypal_type: buy_now, add_to_cart, donation

Catálogo visual

Compare as opções e use o identificador exibido abaixo da prévia no campo correspondente da API.

Imagens e PDF

Para logo próprio, envie qr_code_logo como arquivo ou logo como data URI base64. Para fundo, envie bg_image como arquivo ou data URI e use use_image_background=true. Aceitos: PNG, JPEG, GIF, WebP e SVG sanitizado, até 500.000 bytes por imagem; imagens raster até 4096 × 4096 px. URLs remotas e caminhos arbitrários não são aceitos. Para logo pronto, use um nome retornado por GET /api/qr-codes/options em logo.

PDF: envie pdf_file via multipart, até 104.857.600 bytes (100 MB). Exige a permissão exclusiva de PDF. O documento fica público pelo endereço com UUID. Na edição, reenviar pdf_file troca o documento mantendo o endereço. Não envie url para escolher o endereço de um PDF.

Exemplos prontos

cURL — JSON

curl -X POST "https://gerarqrcode.online/api/qr-codes" \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Campanha","type":"url","url":"https://example.com","pattern":"rounded","marker_out":"rounded","foreground_color":"#223322","size":800,"ecc":"H"}'

cURL — PDF + logo

curl -X POST "https://gerarqrcode.online/api/qr-codes" \
  -H "Authorization: Bearer $API_TOKEN" \
  -F "name=Catalogo" -F "type=pdf" \
  -F "pdf_file=@catalogo.pdf;type=application/pdf" \
  -F "qr_code_logo=@logo.png;type=image/png" \
  -F "qr_code_logo_size=60" -F "ecc=H"

cURL — PATCH

curl -X PATCH "https://gerarqrcode.online/api/qr-codes/UUID" \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Novo nome","foreground_color":"#112233","remove_margin":true}'

cURL — PNG

curl "https://gerarqrcode.online/api/qr-codes/UUID/download?format=png" \
  -H "Authorization: Bearer $API_TOKEN" --output qr-code.png

GET /api/qr-codes/{uuid}/readability

Avaliar legibilidade: nota 0–100, cor, leitura confirmada e mensagem. É uma estimativa de qualidade, não uma probabilidade de leitura.

{
    "data": {
        "score": 100,
        "scale": 100,
        "color": "hsl(120, 70%, 38%)",
        "confirmed": true,
        "message": "Leitura confirmada.",
        "passes": 5,
        "recovered": false,
        "contrast": 21,
        "marginQuality": 1
    }
}

JavaScript — Node.js

const response = await fetch("https://gerarqrcode.online/api/qr-codes", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.API_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({ name: "Contato", type: "vcard", vcard_first_name: "Ana", vcard_phone_numbers: ["+5511999999999"] })
});
const result = await response.json();
if (!response.ok) throw new Error(JSON.stringify(result.errors));
console.log(result.data.uuid);

Resposta de criação/edição

{
    "data": {
        "id": "019a0000-0000-7000-8000-000000000001",
        "uuid": "019a0000-0000-7000-8000-000000000001",
        "name": "Campanha",
        "type": "url",
        "project_id": null,
        "link_id": null,
        "qr_code": "https://gerarqrcode.online/uploads/qr_codes/example.svg",
        "qr_code_logo": null,
        "settings": {
            "url": "https://example.com",
            "size": 800,
            "ecc": "H"
        },
        "url": "https://example.com",
        "pdf_name": null,
        "pdf_size": null,
        "download": "https://gerarqrcode.online/api/qr-codes/019a0000-0000-7000-8000-000000000001/download",
        "datetime": "2026-10-17 12:00:00",
        "last_datetime": "2026-10-17 12:00:00"
    }
}

Erros

400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {"errors":[{"title":"...","status":422}]}.