Documentação da API

Integre a geração, personalização e análise de códigos QR em suas aplicações com nossa API REST. Crie fluxos de trabalho poderosos de códigos QR com apenas algumas chamadas de API.

Início Rápido

Faça sua primeira chamada de API em minutos. Veja como criar um código QR:

Obtenha sua chave de API

Inscreva-se ou faça login, depois visite a página de Desenvolvedores para criar uma chave de API.

Faça seu primeiro pedido

Use a chave da API no cabeçalho X-API-Key:

Exemplo de Solicitação

curl -X POST \
  https://api.iloveqr.com/api/v1/organizations/YOUR_ORG_ID/qr-codes \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "URL",
    "name": "My Website QR",
    "data": {
      "url": "https://example.com"
    }
  }'

Exemplo de Resposta

{
  "id": "qr_abc123",
  "type": "URL",
  "name": "My Website QR",
  "shortUrl": "https://ilqr.co/abc123",
  "data": {
    "url": "https://example.com"
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "totalScans": 0
}

Autenticação

Todas as solicitações de API requerem autenticação usando uma chave de API. Inclua sua chave no cabeçalho da solicitação:

X-API-Key: your_api_key_here

Dica de Segurança: Nunca exponha sua chave de API no código do lado do cliente. Sempre faça chamadas de API a partir do seu servidor ou use variáveis de ambiente.

URL base

Todos os endpoints da API são relativos à seguinte URL base:

https://api.iloveqr.com/api/v1

Limites de Taxa

As solicitações de API têm limite de taxa para garantir uso justo e estabilidade da plataforma:

Curto Prazo

requests/second

Médio Prazo

requests/10 seconds

Longo Prazo

100

requests/minute

Endpoints da API

Explore nossos abrangentes endpoints de API organizados por funcionalidade:

Gerenciamento de QR Code

Crie, atualize e gerencie códigos QR dinâmicos programaticamente

Operações em Lote

Crie centenas de códigos QR de uma só vez por meio de importação CSV ou API

Análise

Rastreie escaneamentos, locais, dispositivos e exporte relatórios detalhados

Webhooks

Receba notificações em tempo real quando os códigos QR forem escaneados

Por que escolher nossa API

Rápido e Confiável

API de baixa latência com SLA de 99,9% de uptime

Seguro por Padrão

Autenticação de chave de API com permissões escopadas

Limitação de Taxa

Limites generosos com respostas de erro claras

SDKs Em Breve

Estamos trabalhando em SDKs oficiais para JavaScript, Python, PHP e mais. Inscreva-se para ser notificado quando estiverem disponíveis.

Precisa de ajuda?

Se você tiver perguntas sobre a API ou precisar de assistência, confira estes recursos:

Central de Ajuda Contato com o Suporte Painel do Desenvolvedor