Documentação da API

Bem-vindo à documentação da API. Clique em uma rota para ver os detalhes.

Rotas de Autenticação

POST /api/autenticacao/

Descrição: Realiza a autenticação do usuário.

Login necessário: Não

Parâmetros:

  • email (obrigatório): Email do usuário.
  • senha (obrigatório): Senha do usuário.

Exemplo de Requisição:

POST /api/auth/login
Content-Type: application/json

{
    "email": "joao@example.com",
    "senha": "senha123"
}

Exemplo de Resposta:

{
    "usuario": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "nome": "João Silva",
        "email": "joao@example.com",
        "ativo": 1
    },
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Rotas de Usuário

GET /api/usuario/

Descrição: Lista os usuários com paginação e pesquisa opcional.

Login necessário: Sim

Parâmetros:

  • paginaAtual (opcional): Número da página.
  • itensPorPagina (opcional): Número de itens por página.
  • termoPesquisa (opcional): Termo para filtrar os usuários.

Exemplo de Requisição:

GET /api/usuario/?paginaAtual=1&itensPorPagina=10&termoPesquisa=Exemplo

Exemplo de Resposta:

{
    "usuarios": [
        {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "nome": "João Silva",
            "email": "joao@example.com",
            "ativo": true
        }
    ],
    "paginacao": {
        "paginaAtual": 1,
        "itensPorPagina": 10,
        "totalRegistros": 100,
        "totalPaginas": 10
    }
}
POST /api/usuario/

Descrição: Cria um novo usuário.

Login necessário: Não

Parâmetros:

  • nome (obrigatório): Nome do usuário.
  • email (obrigatório): Email do usuário.
  • senha (obrigatório): Senha do usuário.

Exemplo de Requisição:

POST /api/usuario/
Content-Type: application/json

{
    "nome": "João Silva",
    "email": "joao@example.com",
    "senha": "senha123"
}

Exemplo de Resposta:

{
    "message": "Usuário criado com sucesso",
    "id": "123e4567-e89b-12d3-a456-426614174000"
}
PUT /api/usuario/

Descrição: Atualiza os dados de um usuário existente.

Login necessário: Sim

Parâmetros:

  • id (obrigatório): ID do usuário.
  • nome (obrigatório): Nome do usuário.
  • email (obrigatório): Email do usuário.
  • senha (obrigatório): Nova senha do usuário.

Exemplo de Requisição:

PUT /api/usuario/
Content-Type: application/json

{
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "nome": "João Silva Atualizado",
    "email": "joao.atualizado@example.com",
    "senha": "novaSenha123"
}

Exemplo de Resposta:

{
    "message": "Usuário atualizado com sucesso",
    "id": "123e4567-e89b-12d3-a456-426614174000"
}
GET /api/usuario/index.php?id={id}

Descrição: Localiza um usuário pelo ID.

Login necessário: Sim

Parâmetros:

  • id (obrigatório): ID do usuário.

Exemplo de Requisição:

GET /api/usuario/index.php?id=123e4567-e89b-12d3-a456-426614174000

Exemplo de Resposta:

{
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "nome": "João Silva",
    "email": "joao@example.com",
    "ativo": true
}
DELETE /api/usuario/index.php?id={id}

Descrição: Deleta um usuário pelo ID.

Login necessário: Sim

Parâmetros:

  • id (obrigatório): ID do usuário.

Exemplo de Requisição:

DELETE /api/usuario/index.php?id=123e4567-e89b-12d3-a456-426614174000

Exemplo de Resposta:

{
    "message": "Usuário deletado com sucesso",
    "id": "123e4567-e89b-12d3-a456-426614174000"
}

Rotas de Clientes

GET /api/cliente/

Descrição: Lista os cliente com paginação e pesquisa opcional.

Login necessário: Sim

Parâmetros:

  • paginaAtual (opcional): Número da página.
  • itensPorPagina (opcional): Número de itens por página.
  • termoPesquisa (opcional): Termo para filtrar os usuários.

Exemplo de Requisição:

GET /api/cliente/?paginaAtual=1&itensPorPagina=10&termoPesquisa=Exemplo

Exemplo de Resposta:

{
    "clientes": [
        {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "nome": "Cliente Exemplo",
            "email": ""
        }
    ],
    "paginacao": {
        "paginaAtual": 1,
        "itensPorPagina": 10,
        "totalRegistros": 100,
        "totalPaginas": 10
    }
}

Rotas de Migrations

Rotas de Projeto

Rotas de Tarefa