Documentação da API

Autenticação

Autenticação da API

Todas as requisições da API requerem autenticação usando uma chave API. Este guia explica como criar, gerenciar e usar chaves API de forma segura.

Obtendo uma Chave API

Para obter uma chave API, você precisa ter uma conta iloveQR e fazer parte de uma organização.

Faça login na sua conta

Faça login ou crie uma conta se você não tiver uma.

Navegue até a página de Desenvolvedores

Vá para Painel → Desenvolvedores para gerenciar suas chaves API.

Crie uma nova chave API

Clique em 'Criar Chave API', dê um nome descritivo e armazene a chave gerada de forma segura.

Usando Sua Chave API

Inclua sua chave API no cabeçalho X-API-Key com cada requisição:

Cabeçalho da Requisição

curl -X GET \
  https://api.iloveqr.com/api/v1/organizations/YOUR_ORG_ID/qr-codes \
  -H "X-API-Key: ilqr_your_api_key_here" \
  -H "Content-Type: application/json"

ID da Organização

A maioria dos endpoints da API requer um ID de organização no caminho da URL. Você pode encontrar seu ID de organização nas configurações do painel ou fazendo uma requisição ao endpoint de organizações.

Obtenha Suas Organizações

curl -X GET \
  https://api.iloveqr.com/api/v1/users/me/organizations \
  -H "X-API-Key: ilqr_your_api_key_here"

Resposta

{
  "organizations": [
    {
      "id": "org_abc123",
      "name": "My Company",
      "slug": "my-company",
      "role": "ADMIN"
    }
  ]
}

Melhores Práticas de Segurança

Nunca exponha chaves API no código do lado do cliente

Sempre faça chamadas de API a partir do seu servidor. Nunca inclua chaves API em JavaScript que roda no navegador, aplicativos móveis ou qualquer código que possa ser visualizado por usuários.

Use variáveis de ambiente

Armazene suas chaves API em variáveis de ambiente, não no seu código. Isso previne exposição acidental através do controle de versão.

Gire as chaves regularmente

Crie novas chaves API periodicamente e revogue as antigas. Se você suspeitar que uma chave foi comprometida, revogue-a imediatamente.

Erros de Autenticação

Quando a autenticação falha, a API retorna uma dessas respostas de erro:

Código de Status	Erro	Descrição
401	UNAUTHORIZED	Chave API ausente ou inválida
403	FORBIDDEN	A chave API não tem permissão para esta ação
403	API_KEY_REVOKED	A chave API foi revogada

Exemplo de Resposta de Erro

{
  "statusCode": 401,
  "message": "Invalid or missing API key",
  "error": "Unauthorized"
}

Próximos Passos

Agora que você entende a autenticação, aprenda como usar a API: