Administrador

A API de Administração contém endpoints de alto nível para a configuração e instalação inicial do sistema. Suas funções incluem a criação do usuário root e o gerenciamento de configurações globais da aplicação.

Acesso Altamente Restrito

Os endpoints descritos nesta página são extremamente sensíveis e não utilizam a autenticação JWT padrão. Eles são projetados para serem usados apenas durante a instalação ou para manutenção por administradores de sistema. O acesso a essas rotas deve ser rigorosamente controlado a nível de infraestrutura (ex: firewall, VPN, ou acesso local).

---

Instalação do Sistema

1. Instalar o Sistema (Criar Usuário Root)

Este método executa a rotina de instalação inicial, que normalmente inclui a criação do primeiro usuário administrador (root) com base nas variáveis de ambiente (.env) definidas no servidor.

Endpoint:

POST /admin/install

Parâmetros: Nenhum.

Exemplo de Resposta (200 OK):

{
  "status": "success",
  "message": "Usuário root criado com sucesso.",
  "user": {
    "id": 1,
    "login": "root",
    "name": "Administrador do Sistema",
    "perfil": "Admin"
  }
}

---

Gerenciamento de Configurações

Endpoints para criar, ler, atualizar e deletar (CRUD) as configurações da aplicação.

2. Criar uma nova configuração

Adiciona uma nova chave de configuração ao banco de dados.

Endpoint:

POST /admin

Corpo da Requisição (application/json):

{
  "config": "SMTP_PORT",
  "value": "587",
  "description": "Porta para o serviço de envio de e-mails."
}

3. Listar todas as configurações

Retorna uma lista de todas as configurações salvas no sistema.

Endpoint:

GET /admin

Exemplo de Resposta (200 OK):

[
  {
    "key": 1,
    "config": "SMTP_PORT",
    "value": "587",
    "description": "Porta para o serviço de envio de e-mails."
  },
  {
    "key": 2,
    "config": "MAX_UPLOAD_SIZE_MB",
    "value": "50",
    "description": "Tamanho máximo para upload de arquivos em Megabytes."
  }
]

4. Consultar configuração por chave

Busca e retorna uma configuração específica com base na sua chave (key).

Endpoint:

GET /admin/:key

Parâmetros de Rota:

Parâmetro	Tipo	Descrição
key	number	ID da configuração a ser consultada.

5. Atualizar uma configuração

Atualiza o valor ou a descrição de uma configuração existente.

Endpoint:

PUT /admin/:key

Parâmetros de Rota:

Parâmetro	Tipo	Descrição
key	number	ID da configuração a ser atualizada.

Corpo da Requisição (application/json):

{
  "value": "100",
  "description": "Tamanho máximo (em MB) para upload de arquivos de vídeo."
}

6. Deletar uma configuração

Remove permanentemente uma configuração do sistema.

Endpoint:

DELETE /admin/:key

Parâmetros de Rota:

Parâmetro	Tipo	Descrição
key	number	ID da configuração a ser deletada.

Exemplo de Resposta (200 OK):

{
  "message": "Configuração deletada com sucesso",
  "key": 2
}