Introdução à API

​

O que pode fazer

​

Guias

​

URL base

https://getqr.com/api/v1

​

Versões

• As alterações incompatíveis saem com um novo prefixo de versão, como /api/v2/, e /api/v1/ continua a funcionar.
• As alterações compatíveis, como novos campos opcionais ou novos endpoints, podem surgir dentro da v1. Ignore os campos da resposta que o seu código não reconheça.

​

Início rápido

curl https://getqr.com/api/v1/health

curl -X POST "https://getqr.com/api/v1/qrs" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: first-qr-0001" \
  -d '{
    "qrType": "website",
    "data": "https://example.com",
    "title": "Landing page"
  }'

curl "https://getqr.com/api/v1/qrs/{qrId}/download?format=png&resolution=1024" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  --output qr-code.png

​

Pedidos e respostas

• Formato. Envie o corpo dos pedidos em JSON com Content-Type: application/json. A exceção é o carregamento de CSV da criação em massa, que usa multipart/form-data.
• Respostas. As respostas são em JSON. As transferências, como as imagens de QR e os arquivos ZIP da criação em massa, devolvem o próprio ficheiro.
• Datas. As datas são strings ISO 8601 em UTC, por exemplo 2026-08-01T10:00:00.000Z.
• Parâmetros de consulta. Os parâmetros booleanos aceitam as strings true ou false.
• Atualizações parciais. Os endpoints PATCH só alteram os campos que enviar.
• Segredos. As respostas nunca incluem palavras-passe nem identificadores internos. Um código QR protegido por palavra-passe indica apenas passwordProtected: true.
• Espaço de trabalho. Cada pedido é executado no espaço de trabalho a que pertence a sua chave de API. Não indica nenhum ID de espaço de trabalho. Consulte Acesso e funções.
• Erros. Os pedidos falhados devolvem um objeto error com um code estável. Consulte Erros.

​

Paginação

{
  "data": [ … ],
  "pagination": { "page": 1, "pageSize": 50, "total": 128, "hasMore": true }
}

​

Idempotência

-H "Idempotency-Key: order-4821-qr"

• Se repetir o pedido com a mesma chave no prazo de 24 horas, recebe a resposta original em vez de um segundo código QR.
• O cabeçalho de resposta x-idempotent-replay é true numa resposta repetida e false numa nova.
• Se o primeiro pedido com essa chave ainda estiver em curso, a API responde 409 conflict. Repita quando terminar.
• Se reutilizar uma chave com outro corpo de pedido, a resposta é 422 unprocessable_entity.
• Sem o cabeçalho, um corpo de pedido idêntico enviado no espaço de 30 segundos é tratado como duplicado.

​

Limites de pedidos

​

Brevemente

​

Próximos passos