Essa API foi desenvolvida para utilizar com o sistema de provisionamento, utilizando Node.js.
- Create
- Read
- Update
- Delete
Para rodar esse projeto, você vai precisar adicionar as seguintes variáveis de ambiente no seu .env
SUPABASE_URL
= DATABASE URL
SUPABASE_HOSTNAME
= postgres
SUPABASE_DBUSER
= postgres
SUPABASE_PASSWORD
= DATABASE PASSWORD
SUPABASE_PORT
= DATABASE PORT
SECRET
= JWT SECRET
Clone o projeto
git clone https://github.com/jeancarloshs/apiProvisionamento.git
Entre no diretório do projeto
cd apiProvisionamento
Instale as dependências
npm install
Inicie o servidor
npm run dev
URL para testes
127.0.0.1:3000
POST /login
Parâmetro | Tipo | Descrição |
---|---|---|
email |
string |
Obrigatório. O EMAIL do usuario para autenticar |
password |
string |
Obrigatório. O PASSWORD do usuario para autenticar |
Parâmetro | Tipo | Descrição |
---|---|---|
token |
string |
Obrigatório. A chave da sua API |
GET /listaUsuarios
GET /listaUsuario/:id
Parâmetro | Tipo | Descrição |
---|---|---|
id |
string |
Obrigatório. O ID do item que você quer |
GET /listaClientes
GET /buscaCliente
Parâmetro | Tipo | Descrição |
---|---|---|
nomeCliente |
string |
Obrigatório. O nomeCliente que você quer pesquisar |
GET /buscaServicoTecnico
Parâmetro | Tipo | Descrição |
---|---|---|
tecnicoRua |
string |
Obrigatório. O tecnicoRua que você quer pesquisar os serviços realizados |
GET /buscaServicoSuporte
Parâmetro | Tipo | Descrição |
---|---|---|
tecnicoSup |
string |
Obrigatório. O tecnicoSup que você quer pesquisar os serviços realizados |
GET /buscaSerialNumber/:id
Parâmetro | Tipo | Descrição |
---|---|---|
id |
string |
Obrigatório. O ID do item que você quer |
GET /buscaPatrimonio/:id
Parâmetro | Tipo | Descrição |
---|---|---|
id |
string |
Obrigatório. O ID do item que você quer |
GET /buscaTipoDeServico
Parâmetro | Tipo | Descrição |
---|---|---|
tipoDeAtivacao |
string |
Obrigatório. O tipoDeAtivacao que você quer |
GET /listaArquivos
GET /listaServicos
POST /provisionaClientes
Parâmetro | Tipo | Descrição |
---|---|---|
nomeCliente |
string |
Obrigatório. O nomeCliente que você quer |
enderecoCliente |
string |
Obrigatório. O enderecoCliente que você quer |
tecnicoRua |
string |
Obrigatório. O tecnicoRua que você quer |
numeroDeSerie |
string |
Obrigatório. O numeroDeSerie que você quer |
posicionamento |
string |
Obrigatório. O posicionamento que você quer |
tecnicoSup |
string |
Obrigatório. O tecnicoSup que você quer |
tipoDeServico |
string |
Obrigatório. O tipoDeServico que você quer |
POST /inserirUsuario
Parâmetro | Tipo | Descrição |
---|---|---|
nomeFuncionario |
string |
Obrigatório. O nomeFuncionario que você quer |
cargoFuncionario |
string |
Obrigatório. O cargoFuncionario que você quer |
emailFuncionario |
string |
Obrigatório. O emailFuncionario que você quer |
senhaFuncionario |
string |
Obrigatório. O senhaFuncionario que você quer |
admin |
bool |
Obrigatório. O admin que você quer |
permissaoDoColaborador |
string |
Obrigatório. O permissaoDoColaborador que você quer |
status |
int |
Obrigatório. O status que você quer |
POST /atualizarUsuario/:id
Parâmetro | Tipo | Descrição |
---|---|---|
nomeFuncionario |
string |
Obrigatório. O nomeFuncionario que você quer |
cargoFuncionario |
string |
Obrigatório. O cargoFuncionario que você quer |
emailFuncionario |
string |
Obrigatório. O emailFuncionario que você quer |
senhaFuncionario |
string |
Obrigatório. O senhaFuncionario que você quer |
admin |
bool |
Obrigatório. O admin que você quer |
permissaoDoColaborador |
string |
Obrigatório. O permissaoDoColaborador que você quer |
status |
int |
Obrigatório. O status que você quer |
POST /criarTipoDeServico
Parâmetro | Tipo | Descrição |
---|---|---|
tipoDeServico |
string |
Obrigatório. O tipoDeServico que você quer |
POST /atualizaTipoDeServico/:id
Parâmetro | Tipo | Descrição |
---|---|---|
tipoDeServico |
string |
Obrigatório. O tipoDeServico que você quer |
POST /inserirArquivo
Parâmetro | Tipo | Descrição |
---|---|---|
nomeArquivo |
string |
Obrigatório. O nomeArquivo que você quer |
urlArquivo |
string |
Obrigatório. O urlArquivo que você quer |
POST /atualizarArquivo/:id
Parâmetro | Tipo | Descrição |
---|---|---|
nomeArquivo |
string |
Obrigatório. O nomeArquivo que você quer |
urlArquivo |
string |
Obrigatório. O urlArquivo que você quer |
DELETE /removeCliente/:id
DELETE /deletarUsuario/:id
DELETE /deletarTipoDeServico/:id
DELETE /deletarArquivo/:id
Front-end: React, NextJS, TailwindCSS
Back-end: Node, Express, Sequelize
O que você aprendeu construindo esse projeto? Quais desafios você enfrentou e como você superou-os?
Esse projeto foi a segunda API em Node.JS que criei do zero, utilizei um pouco da base do primeiro projeto para iniciar este, porem inseri novas funcionalidades, como por exemplo o JWT e esse projeto está sendo utilizado no dia-a-dia pela equipe da empresa, então sempre que precisa de alguma funcionalidade nova ou correção o pessoal me aciona para poder atender a necessidade.
Que melhorias você fez no seu código? Ex: refatorações, melhorias de performance, acessibilidade, etc
Além das refatorações, estou pensando em fazer a integração com a OLT da Nokia, para que a equipe não precise ficar acessando o equipamento toda vez que for ativar algum cliente
Esse projeto é usado pelas seguintes empresas:
- Naxos Telecom Comercio E Servicos Eireli