Skip to main content
Disponível apenas no plano Agências
A API da Macaly usa chaves API para autenticação. As chaves API são associadas a uma equipa e partilham o mesmo sistema de créditos que a interface web.

Obter uma chave API

  1. Inicia sessão na tua conta Macaly
  2. Clica no teu perfil (canto superior direito)
  3. Vai a Definições → Chaves API
  4. Clica em “Criar nova chave API”
  5. Copia a chave imediatamente (só é mostrada uma vez)

Usar a chave API

Inclui a chave API no cabeçalho Authorization em todos os pedidos:

Exemplo de pedido

Formato da chave API

Boas práticas de segurança

As chaves API dão acesso total aos recursos e créditos da tua equipa. Trata-as como palavras-passe.
  1. Guarda as chaves em segurança - Usa variáveis de ambiente, nunca as incluas no código
  2. Renova as chaves regularmente - Revoga e recria chaves periodicamente
  3. Usa chaves separadas - Cria chaves diferentes para diferentes ambientes/aplicações
  4. Monitoriza o uso - Verifica o teu saldo regularmente através do painel
  5. Revoga chaves comprometidas - Se uma chave for exposta, revoga-a imediatamente

Limites de pedidos

  • As tentativas falhadas com a chave API estão sujeitas a um limite de 5 por minuto por endereço IP
  • Isto protege contra ataques de força bruta

Gestão de chaves

Podes gerir as tuas chaves API no painel da Macaly:
  • Ver chaves - Vê todas as chaves ativas com a respetiva data de criação e última utilização
  • Criar chaves - Gera novas chaves com nomes opcionais para identificação
  • Revogar chaves - Desativa chaves que já não são necessárias ou que foram comprometidas