Documentação da API
Autenticação

Autenticação de API

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

Obtendo uma Chave de API

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

1

Faça login na sua conta

Entrar ou criar uma conta se você não tiver uma.

2

Navegue até a página de Desenvolvedores

Vá para Dashboard → Developers para gerenciar suas chaves de API.

3

Crie uma nova chave de API

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

Usando sua chave de API

Inclua sua chave de API no cabeçalho X-API-Key com cada solicitaçã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 solicitaçã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"
    }
  ]
}

Práticas Recomendadas de Segurança

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

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

Use variáveis de ambiente

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

Gire as chaves regularmente

Crie novas chaves de 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 StatusErroDescrição
401
UNAUTHORIZEDChave de API ausente ou inválida
403
FORBIDDENA chave da API não tem permissão para esta ação
403
API_KEY_REVOKEDA chave da 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 autenticação, aprenda como usar a API: