Autenticação
Todas as requisições à API requerem o header X-Api-Key.
API Key
A API Key é criada no Dashboard do Grwthy, na página API Keys. Cada key pertence a um usuário e está vinculada a um Business Account, dando acesso às instâncias daquele account.
Criando API Keys
Ao criar uma key no Dashboard, você pode:
- Dar um nome descritivo (ex: “Produção”, “Staging”, “Testes”)
- Definir uma data de expiração ou escolher “Nunca expira”
A API key completa é exibida apenas uma vez no momento da criação. Armazene-a com segurança.
Expiração
Keys com data de expiração são automaticamente invalidadas após a data configurada. Requisições com keys expiradas retornam:
{
"statusCode": 401,
"message": "API key expired"
}
Revogação
Keys podem ser revogadas a qualquer momento no Dashboard. Uma key revogada é imediatamente invalidada e não pode ser reativada.
Respostas de Erro
| Status | Descrição |
|---|
401 | API key ausente, inválida ou expirada |
{
"statusCode": 401,
"message": "Missing X-Api-Key header"
}
Boas Práticas
- Armazene API keys em variáveis de ambiente, nunca no código-fonte
- Crie keys separadas para ambientes diferentes (produção, staging, desenvolvimento)
- Configure expiração para keys temporárias
- Revogue keys que não são mais necessárias
