Bem-vindo à seção de API Key. A segurança é um pilar fundamental da API Messagefy, e a autenticação de todas as requisições é garantida pelo uso de chaves de API. Uma chave de API é um token único que identifica sua aplicação e autoriza o acesso aos nossos endpoints.Nesta seção, você aprenderá a gerenciar suas chaves de API para garantir um acesso seguro e controlado. Os endpoints disponíveis permitem:Criação: Gerar novas chaves de API para suas aplicações.
Listagem: Visualizar todas as chaves associadas à sua conta.
Busca: Obter detalhes de uma chave específica.
Atualização: Modificar propriedades de uma chave (ex: desativar temporariamente).
Deleção: Revogar permanentemente o acesso de uma chave.
Trate suas chaves de API como senhas. Não as exponha em código do lado do cliente (client-side).
Utilize variáveis de ambiente para armazenar suas chaves no servidor.
Crie chaves distintas para diferentes aplicações para granular o acesso e facilitar a revogação em caso de comprometimento.
Todas as requisições à API devem incluir a chave no cabeçalho api-key.
Para que serve uma API Key?#
Autenticação Segura - Cada requisição à API deve incluir uma API Key válida no header Authorization. Isso garante que apenas aplicações autorizadas possam acessar seus recursos. Sem uma API Key válida, a requisição é rejeitada com erro 401 Unauthorized.Controle de Permissões Granular - Através dos scopes, você define exatamente o que cada API Key pode fazer. Por exemplo, uma chave pode ter permissão apenas para enviar mensagens (messages:write), enquanto outra pode apenas ler estatísticas (stats:read). Isso segue o princípio de menor privilégio.Rastreabilidade e Auditoria - Cada API Key possui um identificador único e todas as requisições são registradas. Você pode saber exatamente qual chave foi usada para cada ação, facilitando auditoria de segurança e troubleshooting.Revogação Instantânea - Se uma API Key for comprometida, você pode revogá-la imediatamente sem afetar outras chaves. Isso é muito mais seguro do que compartilhar uma única senha entre múltiplas aplicações.Segregação de Ambientes - Você pode ter chaves diferentes para desenvolvimento, staging e produção, cada uma com permissões e configurações apropriadas para o ambiente. Modificado em 2026-01-22 21:53:15
