Documentação da API

Códigos QR

API de Códigos QR

Crie, atualize e gerencie códigos QR dinâmicos programaticamente. Cada código QR pode ser personalizado com cores, logotipos e recursos de rastreamento.

Pontos finais

Método	Ponto final	Descrição
POST	/organizations/:orgId/qr-codes	Crie um novo código QR
GET	/organizations/:orgId/qr-codes	Liste todos os códigos QR
GET	/organizations/:orgId/qr-codes/:id	Obter um código QR específico
PUT	/organizations/:orgId/qr-codes/:id	Atualizar um código QR
DELETE	/organizations/:orgId/qr-codes/:id	Excluir um código QR
GET	/organizations/:orgId/qr-codes/:id/download	Baixar imagem do código QR

Criar Código QR

Crie um novo código QR dinâmico com conteúdo e estilo personalizáveis.

POST

/organizations/:orgId/qr-codes

Corpo da Solicitação

Parâmetro	Tipo	Requerido	Descrição
type	string	Requerido	Tipo de código QR (URL, VCARD, WIFI, etc.)
name	string	Requerido	Nome de exibição para o código QR
data	object	Requerido	Dados de conteúdo (varia de acordo com o tipo)
style	object	Opcional	Opções de personalização visual
folderId	string	Opcional	Pasta para organizar o código QR
tags	string[]	Opcional	Tags para categorização

Exemplos por Tipo

Código QR de URL

curl -X POST \
  https://api.iloveqr.com/api/v1/organizations/org_abc123/qr-codes \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "URL",
    "name": "Company Website",
    "data": {
      "url": "https://example.com"
    },
    "style": {
      "foregroundColor": "#000000",
      "backgroundColor": "#FFFFFF",
      "cornerRadius": 10
    }
  }'

Resposta

{
  "id": "qr_xyz789",
  "type": "URL",
  "name": "Company Website",
  "shortUrl": "https://ilqr.co/xyz789",
  "shortCode": "xyz789",
  "data": {
    "url": "https://example.com"
  },
  "style": {
    "foregroundColor": "#000000",
    "backgroundColor": "#FFFFFF",
    "cornerRadius": 10
  },
  "status": "ACTIVE",
  "totalScans": 0,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Listar Códigos QR

Recupere uma lista paginada de códigos QR com filtragem opcional.

GET

/organizations/:orgId/qr-codes

Parâmetros de Consulta

Parâmetro	Tipo	Descrição
page	number	Número da página (padrão: 1)
limit	number	Itens por página (padrão: 20, máximo: 100)
type	string	Filtrar por tipo de código QR
folderId	string	Filtrar por pasta
search	string	Pesquisar pelo nome
status	string	Filtrar por status (ATIVO, ARQUIVADO)

Atualizar QR Code

Atualize o conteúdo, estilo ou metadados de um QR code existente. A imagem do QR code permanece a mesma enquanto o destino muda.

PUT

/organizations/:orgId/qr-codes/:id

curl -X PUT \
  https://api.iloveqr.com/api/v1/organizations/org_abc123/qr-codes/qr_xyz789 \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Website",
    "data": {
      "url": "https://new-url.example.com"
    }
  }'

Excluir Código QR

Excluir permanentemente um código QR. Esta ação não pode ser desfeita. A URL curta deixará de funcionar.

DELETE

/organizations/:orgId/qr-codes/:id

curl -X DELETE \
  https://api.iloveqr.com/api/v1/organizations/org_abc123/qr-codes/qr_xyz789 \
  -H "X-API-Key: YOUR_API_KEY"

Tipos de Código QR Suportados

URL

Link para qualquer site ou página da web

VCARD

Compartilhar informações de contato

WIFI

Conectar a redes WiFi

PDF

Link para documentos PDF

EMAIL

Composição de e-mail pré-preenchida

SMS

Mensagem SMS pré-preenchida

PHONE

Chamada telefônica direta

TEXT

Conteúdo em texto simples

APP

Links da loja de aplicativos

VIDEO

Links de conteúdo em vídeo

SOCIAL

Links de redes sociais

Próximos Passos

Saiba mais sobre recursos relacionados: