Link da api: https://testedeploybackm5-8b207db3eb59.herokuapp.com/ ;
Bem-vindo à API Garotos de Programa! Esta API permite que você registre e edite usuários, faça login e cadastre clientes. Tudo com validações rigorosas para garantir a segurança dos dados.
-
Cadastro de Usuário:
POST /signUp -
💡 Observação: Todos os dados obrigatórios estão identificados com "*". E caso não sejam preenchidos ou enviados com valor vazio haverá um retorno com os seguintes dados:
status(400)
Dados não enviados:
{ message: O campo "nome do campo" é obrigatório. }
Envio de dados vazios:
{ message: O campo "nome do campo" não pode estar vazio. }
Para cadastrar um novo usuário, você deve fornecer os seguintes dados:
-
nome* : Nome do usuário (deve conter nome e sobrenome, sendo apenas letras e espaços). -
email* : Endereço de e-mail válido (Se já estiver cadastrado será retonado um erro). -
password* : Senha com pelo menos 8 caracteres, incluindo pelo menos um número, um caractere especial e uma letra maiúscula.
- Aqui está um exemplo de como fazer uma requisição para cadastrar um novo usuário:
POST /signup Content-Type: application/json
{ "nome": "Exemplo", "email": "exemplo@email.com", "password": "Senha123!" }
Respostas: Sucesso (Status 201):
- Se todas as validações forem bem-sucedidas, o usuário será cadastrado e a API retornará uma mensagem de sucesso:
{ "message": "Usuário cadastrado com sucesso!" }
Erros Possíveis:
- A API retornará mensagens de erro específicas para cada validação não atendida. Aqui estão alguns exemplos:
Status 400 (Bad Request) - Validação de Nome:
{ "message": "Nome deve conter apenas letras ou espaços." }
Status 400 (Bad Request) - Validação de E-mail:
{"message": "Endereço de e-mail inválido."}
Status 400 (Bad Request) - E-mail já registrado:
{ "message": "Email já cadastrado." }
Status 400 (Bad Request) - Validação de Senha:
{ "message": "A senha deve ter pelo menos 8 caracteres, incluindo um número, um caractere especial e uma letra maiúscula." }
- Login de Usuário:
POST /login
Para fazer login, você deve fornecer os seguintes dados:
email*: Endereço de e-mail registrado.password*: Senha correspondente à conta.
Aqui está um exemplo de como fazer uma requisição para fazer login:
POST /login Content-Type: application/json
{ "email": "exemplo@email.com", "password": "Senha123!" }
Respostas: Sucesso (Status 200):
- Se as credenciais de login estiverem corretas, a API retornará um objeto contendo o nome do usuário, seu e-mail e um token de autenticação:
{ "name": "Exemplo", "email": "exemplo@email.com", "token": "seu-token-de-autenticacao" }
Erros Possíveis:
- A API retornará mensagens de erro específicas em caso de problemas durante o processo de login:
Status 404 (Not Found) - Usuário não encontrado:
{ "message": "Usuário não encontrado." }
Status 404 (Not Found) - Senha incorreta:
{ "message": "A senha não confere." }
- Cadastro de Usuário:
GET /user/id
-
O usuário deve estar autenticado para poder fazer o get de informações
- Não precisa enviar o ID do usuário na rota pois o ID é validado pelo token do usuário logado
GET /user Content-Type: application/json headers: { 'Authorization':
Bearer ${token}};
Respostas: Sucesso (Status 200):
- Se todas as validações forem bem-sucedidas, o usuário será cadastrado e a API retornará um objeto contendo as informações do usuario:
{ "nome": "Novo Nome", "email": "novo@email.com", "cpf": "12345678901", "telephone": "1234567890", "password": "senhaCriptografadaHash" }
Erros Possíveis:
- A API retornará mensagens de erro específicas para cada validação não atendida. Aqui estão alguns exemplos:
Status 404 (Not Found) - Validação de ID:
{ "message": "Usuário não encontrado." }
- Edição de Usuário:
PUT /user/update
-
Para editar um usuário existente, você pode fornecer os seguintes dados:
-
nome*: Nome do usuário (deve conter apenas letras). -
email*: Endereço de e-mail válido (não pode já estar registrado no banco de dados). -
cpf: CPF válido com exatamente 11 caracteres (apenas números). -
telefone: Número de telefone (apenas números). -
password* : : Senha com pelo menos 8 caracteres, incluindo pelo menos um número, um caractere especial e uma letra maiúscula.
-
Aqui está um exemplo de como fazer uma requisição para editar um usuário existente:
-
O usuário deve estar autenticado para poder fazer a alteração de suas informações
- Não precisa enviar o ID do usuário na rota pois o ID é validado pelo token do usuário logado
PUT /user/update Content-Type: application/json
headers: { 'Authorization':
Bearer ${token}};{ "nome": "Novo Nome", "email": "novo@email.com", "cpf": "12345678901", "telefone": "1234567890" }
Respostas:
Sucesso (Status 200):
- Se todas as validações forem bem-sucedidas, o usuário será atualizado e a API retornará uma mensagem de sucesso:
{"message": "Usuário atualizado com sucesso!"}
Erros Possíveis:
- A API retornará mensagens de erro específicas para cada validação não atendida. Aqui estão alguns exemplos:
Status 400 (Bad Request) - Nenhum dado foi alterado:
{"message": "Ao menos um campo deve ser alterado."}
Status 400 (Bad Request) - Validação de Nome:
{"message": "Nome deve conter apenas letras e espaços."}
Status 400 (Bad Request) - Validação de E-mail:
{"message": "Endereço de e-mail inválido."}
Status 400 (Bad Request) - E-mail já registrado:
{"message": "Email já está registrado."}
Status 400 (Bad Request) - Validação de CPF:
{"message": "CPF inválido. Deve conter exatamente 11 dígitos."}
Status 400 (Bad Request) - Validação de Telefone:
{"message": "O campo telefone deve conter apenas números."}
Status 400 (Bad Request) - Validação de Senha:
{ "message": "A senha deve ter pelo menos 8 caracteres, incluindo um número, um caractere especial e uma letra maiúscula." }
- Cadastro de Cliente:
POST /customer
-
Para cadastrar um novo cliente, você deve fornecer os seguintes dados:
-
id_responsable*: Esse dado é fornecido automáticamente de acordo com o token do usuário logado. -
nome*: Nome do cliente (deve conter apenas letras). -
email*: Endereço de e-mail válido (não pode já haver o mesmo e-mail de cliente cadastrado). -
telephone*: Número de telefone (apenas números). -
cep*: CEP válido com no máximo 8 caracteres (apenas números). -
logradouro*: Logradouro (deve ser obrigatório). -
complemento*: Complemento (não é obrigatório). -
bairro*: Bairro (obrigatório). -
cidade*: Cidade (obrigatória). -
estado*: Estado (obrigatório e somente letras).
-
Aqui está um exemplo de como fazer uma requisição para cadastrar um novo cliente:
-
O usuário deve estar autenticado para poder cadastrar um novo cliente
- Não precisa enviar o ID do usuário na rota pois o ID é validado pelo token do usuário logado
POST /customer Content-Type: application/json
headers: { 'Authorization':
Bearer ${token}};{ "nome": "Cliente Exemplo", "email": "cliente@email.com", "cpf": "11122233345", "telephone": "1234567890", "cep": "12345678", "logradouro": "Rua Exemplo, 123", "complemento": "Apto 123", "bairro": "Bairro Exemplo", "cidade": "Cidade Exemplo", "estado": "SP" }
Respostas:
Sucesso (Status 201):
Se todas as validações forem bem-sucedidas, o cliente será cadastrado e a API retornará uma mensagem de sucesso:
{"message": "Cliente cadastrado com sucesso!"}
Erros Possíveis:
A API retornará mensagens de erro específicas para cada validação não atendida. Aqui estão alguns exemplos:
Status 400 (Bad Request) - Validação de Nome:
{"message": "Nome deve conter apenas letras."}
Status 400 (Bad Request) - Verificação existência de CPF:
{"message": "CPF já cadastrado"}
Status 400 (Bad Request) - Validação de CPF:
{"message": "O CPF deve conter exatamente 11 caracteres"}
Status 400 (Bad Request) - Validação de CPF:
{"message": "O CPF deve conter apenas números"}
Status 400 (Bad Request) - Validação de E-mail:
{"message": "O e-mail deve ter um formato válido, exemplo: email@email.com"}
Status 400 (Bad Request) - E-mail já cadastrado:
{"message": "Email já está cadastrado."}
Status 400 (Bad Request) - Validação de Telefone:
{"message": "Número de telefone inválido. Deve conter apenas dígitos numéricos."}
Status 400 (Bad Request) - Validação de CEP:
{"message": "O CEP deve ter no máximo 8 caracteres."}
Status 400 (Bad Request) - Validação de Estado:
{"message": "Estado inválido. Deve conter apenas letras."}
Equipe Garotos de Progarama email: nossoemail@email.com
Sinta-se à vontade para entrar em contato conosco caso tenha alguma dúvida ou problema!