Bem-vindo ao guia completo de integração com a MessageFy! Este documento foi criado para te ajudar a integrar sua aplicação de forma rápida e segura.Pensamos em cada passo para que você tenha uma experiência única e consiga transacionar com poucas linhas de código.A API MessageFy utiliza API Keys como método de autenticação. Todas as requisições à API devem incluir uma API Key válida no header. Este documento descreve como obter, usar e gerenciar suas credenciais de autenticação de forma segura.URL Dev: https://api-dev.messagefy.io
Pré-requisitos#
Antes de obter uma API Key, você precisa:1.✅ Ter uma Organization criada (feito no cadastro)
2.✅ Ter uma Account criada dentro da Organization
3.✅ Ter API Key de dentro da AccountBoas Práticas#
1.
Armazene sua API KEY em variáveis de ambiente.
Configure .gitignore adequadamente
Use diferentes chaves por ambiente
Trate erros de autenticação adequadamente
2.
Rotacione chaves periodicamente
Revogue chaves comprometidas imediatamente
Use HTTPS em todas as requisições
Use serviços de gerenciamento de segredos
3.
Separe chaves por aplicação.
Documente quais chaves são usadas onde.
Tenha plano de contingência
FAQ#
Como obtenho minha primeira API Key?#
Cadastre-se no MessageFy (cria Organization automaticamente)
Gere uma API Key via dashboard ou API
Posso usar a mesma API Key em múltiplas aplicações?#
Tecnicamente sim, mas não é recomendado. Cada aplicação deve ter sua própria API Key para:Facilitar revogação em caso de comprometimento
Quantas API Keys posso ter?#
Não há limite técnico, mas recomendamos:Produção: 2-3 chaves (principal + backup)
Desenvolvimento: 1-2 chaves por desenvolvedor
Total por Account: Máximo 10-15 chaves ativa
O que fazer se minha API Key vazar?#
⚠️ Revogue imediatamente via dashboard ou API
📝 Atualize todas as aplicações
🔍 Revise logs para identificar uso não autorizado
📊 Investigue como ocorreu o vazamento
Modificado em 2026-02-11 12:53:27
