Skip to main content

Autenticação

A API MessageFy utiliza API Keys para autenticação. Todas as requisições passam pelo gateway APISIX, que valida a chave e injeta headers de contexto automaticamente.
Esta página trata da autenticação da API REST (a chave que assina cada requisição HTTP). Isso é diferente da conexão/autenticação do dispositivo WhatsApp (parear o número ao canal), feita por QR Code, Pair Code, Link, Importação de Sessão ou Passkey. Para conectar um número, consulte Iniciar Sessão, Importar Sessão e Confirmar Passkey.

Como funciona

1

Obtenha sua API Key

Crie uma API Key pelo painel administrativo ou pela API (POST /api/v1/Admin/ApiKey). A chave está vinculada a uma conta e organização específicas.
2

Envie no header X-API-KEY

Inclua a chave no header X-API-KEY de todas as requisições.
3

Gateway injeta o contexto

O APISIX valida a chave e adiciona automaticamente os headers de identidade na requisição que chega ao backend.

Tipos de Chave

A abrangência de acesso de uma chave é definida pelo tipo da chave, identificado pelo prefixo: O limite de uso é controlado pelo ResourcePlan associado à chave (rate limit), não por permissões granulares. Consulte Administrando API Keys para detalhes.

Exemplo de Requisição

Headers Injetados pelo Gateway

Após a validação da API Key, o gateway APISIX injeta estes headers automaticamente:
Estes headers são gerenciados pelo gateway. Não envie manualmente — eles serão sobrescritos pela validação da API Key.

Rate Limiting

Cada API Key pode ter um plano de recursos (ResourcePlan) associado que define limites de uso. Quando o limite é atingido, a API retorna 429 Too Many Requests.

Erros de Autenticação

Exemplo de erro 401