Services-Syclus API

Backend API de serviços Syclus.

Usuarios 5

Rotas para CRUD de usuários.

Obter todos os usuarios | GET {{URL}}/api/v1/usuarios

Description

Busca todos os usuários no banco de dados.

Obter um usuario específico | GET {{URL}}/api/v1/usuarios/5e5d695854b1f53f4f66a092

Description

Busca um usuário específico por id no banco de dados .

raw

Incluir um novo usuario | POST {{URL}}/api/v1/usuarios

Description

Adiciona um novo usuário no banco de dados.

Headers

Key	Value	Description
Content-Type	application/json

Body

{ "nome": "Jane Doe", "email": "jane@gmail.com", "senha": "123456" }

raw

Alterar um usuário | PUT {{URL}}/api/v1/usuarios/5e4d2698343c111b3e64b750

Description

Altera um usuário específico por id.

Headers

Key	Value	Description
Content-Type	application/json

Body

{ "nome": "Jane Smith" }

Exlcuir um usuário | DELETE {{URL}}/api/v1/usuarios/5e4d2698343c111b3e64b750

Description

Exclui um usuário específico por id.

Autenticação 7

Rotas para autenticação de usuários, Registro, Login, Logoff, Atualiza Detalhes, Esqueceu a Senha, Usuário Atual Logado.

raw

Login usuário | POST {{URL}}/api/v1/autenticacao/login

Description

Faz login informando email e senha.

Headers

Key	Value	Description
Content-Type	application/json

Body

{ "email": "newtonduarte@syclus.com.br", "senha": "123456" }

raw

Incluir um usuário | POST {{URL}}/api/v1/autenticacao/register

Description

Inclui um usuário passando os campos: nome, email, senha, cpf_cnpj

Headers

Key	Value	Description
Content-Type	application/json

Body

{ "nome": "Newton Duarte", "email": "newtonduarte@syclus.com.br", "senha": "123456" }

Obter usuário logado por token | GET {{URL}}/api/v1/autenticacao/me

Description

Obtem o usuário logado através do token.

raw

Esqueceu a senha | POST {{URL}}/api/v1/autenticacao/forgotpassword

Description

Envia email com instruções para resetar a senha.

Headers

Key	Value	Description
Content-Type	application/json

Body

{ "email": "newtonduarte@syclus.com.br" }

raw

Resetar senha | PUT {{URL}}/api/v1/autenticacao/resetpassword/2369965a0883d550a144b178846978369cb1e765

Description

Reseta a senha do usuário informando o token que foi enviado por email anteriormente.

Headers

Key	Value	Description
Content-Type	application/json

Body

{ "senha": "123456" }

raw

Alterar detalhes do usuário | PUT {{URL}}/api/v1/autenticacao/updatedetails

Description

Alterar detalhes do usuário: nome ou email.

Headers

Key	Value	Description
Content-Type	application/json

Body

{ "email": "newtonduarte@syclus.com.br", "nome": "Newton Duarte" }

raw

Alterar senha | PUT {{URL}}/api/v1/autenticacao/updatepassword

Description

Altera a senha do usuário logado, enviando no body a senhaAtual e a novaSenha.

Headers

Key	Value	Description
Content-Type	application/json

Body

{ "senhaAtual": "12345678", "novaSenha": "123456" }

Recursos 5

Rotas para CRUD de recursos.

Obter todos os recursos | GET {{URL}}/api/v1/recursos

Description

Busca todos os recursos no banco de dados.

Passar como query string a página e o limite.

Exemplo: ?page=1&limit=10

Query

Key	Value	Description
page	1
limit	10

Obter um recurso específico | GET {{URL}}/api/v1/recursos/5e5d6f75c5d70b428e7d549f

Description

Busca um recurso específico por id no banco de dados.

raw

Incluir um novo recurso | POST {{URL}}/api/v1/recursos

Description

Adiciona um novo recurso no banco de dados.

Headers

Key	Value	Description
Content-Type	application/json

Body

{ "codigo": 1040002, "componente": "actLogVersoes1", "componente_pai": "barSistemaAjuda" }

raw

Alterar um recurso | PUT {{URL}}/api/v1/recursos/5e5d6f75c5d70b428e7d549f

Description

Altera um recurso específico por id.

Headers

Key	Value	Description
Content-Type	application/json

Body

{ "componente": "actLogVersoes5", "componente_pai": "barSistemaAjuda" }

Excluir um recurso | DELETE {{URL}}/api/v1/recursos/5e5d6f75c5d70b428e7d549f

Description

Exlcui um recurso específico por id.

Licenças 5

Rotas para CRUD de licenças.

Obter todas as licenças | GET {{URL}}/api/v1/licencas

Description

Busca todos as licenças no banco de dados.

raw

Obter uma licença específica | GET {{URL}}/api/v1/licencas/5e5d711dc5d70b428e7d54a1

Description

Busca uma licença específica por id no banco de dados.

raw

Incluir uma licença | POST {{URL}}/api/v1/licencas

Description

Adiciona uma licença no banco de dados.

Headers

Key	Value	Description
Content-Type	application/json

Body

{ "titulo": "Licença Syclus Teste", "cliente_id": "5e5d695854b1f53f4f66a092", "conexoes": 10, "aplicativo": "Syclus ERP", "modulos": [ { "codigo": 1000000, "titulo": "tabSistema", "grupos": [ { "codigo": 1010000, "titulo": "barSistemaEmpresas", "recursos": ["*"] }, { "codigo": 1020000, "titulo": "barSistemaAcesso", "recursos": [1020001, 1020002, 1020003, 1020014, 1020015, 1020016] } ] }, { "codigo": 2000000, "titulo": "tabComuns", "grupos": [ { "codigo": 2010000, "titulo": "barComunsPessoas", "recursos": ["*"] }, { "codigo": 2020000, "titulo": "barComunsCadastros", "recursos": [2020001, 2020002, 2020003, 2020004, 2020005] } ] } ], "data_expiracao": "2020-12-31T03:00:00.000Z" }

raw

Alterar uma licença | PUT {{URL}}/api/v1/licencas/5e5d711dc5d70b428e7d54a1

Description

Altera uma licença específica por id.

Headers

Key	Value	Description
Content-Type	application/json

Body

Delete License | DELETE {{URL}}/api/v1/licencas/5e5d711dc5d70b428e7d54a1

Description

Delete license from database.