Listar Configurações de Email

Retorna todas as configurações do grupo de email (SendGrid e MailerSend)

Este endpoint é do tipo: Admin Only

Descrição

Retorna todas as configurações do grupo 'mail' com as seguintes funcionalidades:

Lista todas as configurações de email (SendGrid e MailerSend)
Valores sensíveis (API keys) são mascarados automaticamente
Inclui informações sobre provedor ativo, API keys e remetentes
Permite verificar qual serviço está configurado (sendgrid, mailersend ou nenhum)
Requer autenticação JWT válida e permissão de administrador

Detalhes do Endpoint

VERBO

GET

URL BASE

http://api.provista.hmg.nabrasil.org.br/v1

ENDPOINT

/admin/configs/group/mail

Cabeçalhos

Parâmetro	Valor
Authorization	Bearer <token>
Accept	application/json

Respostas

Sucesso - 200

{
  "success": true,
  "data": {
    "group": "mail",
    "configs": [
      {
        "id": "uuid",
        "key": "mail_provider",
        "value": "sendgrid",
        "description": "Provedor de email a ser usado (sendgrid ou mailersend)",
        "is_sensitive": false,
        "is_active": true
      },
      {
        "id": "uuid",
        "key": "sendgrid_api_key",
        "value": "SG.xxxx****xxxx",
        "description": "Chave de API do SendGrid para envio de emails",
        "is_sensitive": true,
        "is_active": true
      },
      {
        "id": "uuid",
        "key": "sendgrid_from_email",
        "value": "noreply@nunciatura.com.br",
        "description": "Email do remetente padrão (SendGrid)",
        "is_sensitive": false,
        "is_active": true
      },
      {
        "id": "uuid",
        "key": "sendgrid_from_name",
        "value": "Nunciatura Provista",
        "description": "Nome do remetente padrão (SendGrid)",
        "is_sensitive": false,
        "is_active": true
      },
      {
        "id": "uuid",
        "key": "mailersend_api_key",
        "value": "mlsn.xxxx****xxxx",
        "description": "Chave de API do MailerSend para envio de emails",
        "is_sensitive": true,
        "is_active": true
      },
      {
        "id": "uuid",
        "key": "mailersend_from_email",
        "value": "noreply@nunciatura.com.br",
        "description": "Email do remetente padrão (MailerSend)",
        "is_sensitive": false,
        "is_active": true
      },
      {
        "id": "uuid",
        "key": "mailersend_from_name",
        "value": "Nunciatura Provista",
        "description": "Nome do remetente padrão (MailerSend)",
        "is_sensitive": false,
        "is_active": true
      }
    ]
  }
}

Nota: Valores sensíveis (API keys) são mascarados mostrando apenas os primeiros 4 e últimos 4 caracteres. O campo mail_provider pode ser "sendgrid", "mailersend" ou vazio (nenhum serviço configurado).

Erro - 401 (Não autorizado)

{
  "success": false,
  "message": "Token não fornecido"
}

Condição: Token JWT inválido, expirado ou não fornecido

Erro - 403 (Acesso negado)

{
  "success": false,
  "message": "Acesso negado. Apenas administradores podem acessar este endpoint."
}

Condição: Usuário autenticado mas sem permissão de administrador

Erro - 404 (Grupo não encontrado)

{
  "success": false,
  "message": "Grupo não encontrado"
}

Condição: Grupo 'mail' não existe no banco de dados

Códigos de Resposta

Código	Descrição
200	Configurações retornadas com sucesso
401	Token não fornecido ou inválido
403	Acesso negado (apenas administradores)
404	Grupo não encontrado