Visão geral da autenticação

Este guia explica como fazer a autenticação na nossa API. Oferecemos suporte a vários métodos de autenticação:

Chaves de API

O método de autenticação mais simples é usar chaves de API. Cada chave de API está associada a um usuário específico e tem permissões específicas.

// Example API Key request
const response = await fetch('https://api.example.com/data', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

OAuth 2.0

Para aplicações que exigem mais segurança, oferecemos suporte ao fluxo de autenticação OAuth 2.0:

1. Solicitação de autorização: redirecione os usuários para a nossa URL de autorização
2. Consentimento do usuário: o usuário aprova o acesso à conta dele
3. Código de autorização: o nosso servidor retorna um código de autorização
4. Troca de token: troque o código por um token de acesso
5. Requisições à API: use o token de acesso para acessar os recursos protegidos

Tokens JWT

Depois da autenticação, emitimos tokens JWT que contêm informações codificadas sobre o usuário e as permissões dele.

// Example JWT token usage
const response = await fetch('https://api.example.com/protected-resource', {
  headers: {
    'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
  }
});

Gerenciamento de sessões

As sessões são válidas por 24 horas por padrão. Para renovar uma sessão:

const refreshResponse = await fetch('https://api.example.com/auth/refresh', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer CURRENT_REFRESH_TOKEN'
  }
});

// Parse the new tokens
const { accessToken, refreshToken } = await refreshResponse.json();

Boas práticas

1. Nunca armazene chaves de API ou tokens no código do lado do cliente
2. Use variáveis de ambiente para credenciais sensíveis
3. Implemente mecanismos de renovação de token para aplicações de longa duração
4. Defina tempos de expiração adequados para os tokens
5. Use HTTPS em todas as requisições à API