Introdução à API

​

O que você pode fazer

​

Guias

​

URL base

https://getqr.com/api/v1

​

Versionamento

• Mudanças incompatíveis saem com um novo prefixo de versão, como /api/v2/, e /api/v1/ continua funcionando.
• Mudanças compatíveis, como novos campos opcionais ou novos endpoints, podem surgir dentro da v1. Ignore os campos da resposta que seu código não reconhecer.

​

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

​

Requisições e respostas

• Formato. Envie os corpos das requisições em JSON com Content-Type: application/json. A exceção é o upload de CSV da criação em massa, que usa multipart/form-data.
• Respostas. As respostas são em JSON. Downloads, como imagens de QR e arquivos ZIP em massa, retornam o próprio arquivo.
• Datas. As datas são strings ISO 8601 em UTC, por exemplo 2026-08-01T10:00:00.000Z.
• Parâmetros de consulta. Parâmetros booleanos recebem as strings true ou false.
• Atualizações parciais. Endpoints PATCH alteram apenas os campos que você envia.
• Segredos. As respostas nunca incluem senhas nem identificadores internos. Um QR code protegido por senha informa apenas passwordProtected: true.
• Workspace. Toda requisição é executada no workspace ao qual a sua chave de API pertence. Você não informa um ID de workspace. Veja Acesso e funções.
• Erros. Requisições com falha retornam um objeto error com um code estável. Veja Erros.

​

Paginação

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

​

Idempotência

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

• Repetir a requisição com a mesma chave em até 24 horas retorna a resposta original em vez de criar um segundo QR code.
• O cabeçalho de resposta x-idempotent-replay é true para uma resposta repetida e false para uma nova.
• Se a primeira requisição com essa chave ainda estiver em andamento, a API responde 409 conflict. Tente de novo quando ela terminar.
• Reutilizar uma chave com um corpo de requisição diferente retorna 422 unprocessable_entity.
• Sem o cabeçalho, um corpo de requisição idêntico enviado em até 30 segundos é tratado como duplicado.

​

Limites de requisições

​

Em breve

​

Próximos passos