Pular para o conteúdo principal

Endpoints Admin

Os endpoints admin são utilizados pelo painel administrativo web do EloFiel para gestão do tenant. Com exceção do login, esses endpoints não são destinados à integração direta de PDV/ERP.


POST /api/v1/authadmin/login

Autentica um administrador e retorna um token JWT para uso no painel web.

Uso restrito ao painel web

Este endpoint é utilizado pelo painel administrativo do EloFiel. Se você está desenvolvendo uma integração de PDV/ERP, use a autenticação por X-Api-Key descrita nos endpoints PDV.

Request

POST /api/v1/authadmin/login
Content-Type: application/json

Body:

CampoTipoObrigatórioDescrição
emailstringSimE-mail do administrador
senhastringSimSenha do administrador

Exemplo:

{
"email": "gestor@loja.com.br",
"senha": "senha123"
}

Response

HTTP 200ApiResult<LoginResponse>

{
"sucesso": true,
"mensagem": "Login realizado com sucesso.",
"dados": {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"expiraEm": "2026-03-30T12:00:00Z",
"nome": "João Gestor",
"email": "gestor@loja.com.br",
"perfil": "AdminTenant"
},
"erros": []
}

Campos da resposta (dados):

CampoTipoDescrição
tokenstringToken JWT para uso nas requisições admin
expiraEmdatetimeData/hora de expiração do token (UTC)
nomestringNome do usuário autenticado
emailstringE-mail do usuário
perfilstringPerfil de acesso: "AdminTenant" ou "SuperAdmin"

Perfis de acesso:

PerfilDescrição
AdminTenantGestor da loja — acesso restrito ao próprio tenant
SuperAdminEquipe interna EloFiel — acesso total à plataforma

Possíveis erros:

HTTPCausaerros[0]
400E-mail ou senha ausentes"O campo Email é obrigatório."
401Credenciais inválidas"Credenciais inválidas."
429Rate limit excedido"Muitas tentativas. Aguarde 1 minuto."
Rate limit no login

O endpoint de login permite no máximo 5 tentativas por minuto por IP. Após esse limite, o servidor retorna HTTP 429. Consulte a documentação de rate limiting para detalhes sobre backoff.


Endpoints /api/v1/admin/{recurso}

Os demais endpoints admin seguem o padrão REST com autenticação Bearer:

Authorization: Bearer {token_jwt}

Esses endpoints gerenciam recursos como lojas, campanhas, clientes e relatórios do painel administrativo. Eles não são documentados aqui pois não fazem parte da integração PDV/ERP.

Se você é desenvolvedor do painel administrativo, consulte a documentação interna ou o Swagger disponível em /swagger no ambiente de desenvolvimento.