API de clientes, é um projeto para criar um cliente, com os dados de: razão social, CNPJ e e-mail.

API foi criada com os métodos Http, com todos os endpoints do Http: Get, Post, Put, Delete. Para realizar todas as operações, será necessário registrar e autenticar o um novo usuário.

• PHP PHP Download
• Laravel versão 9 Laravel V9 Download
• My SQL MySQL Download
• Xampp caso queria baixar o PHP e My SQL Xampp Download
• Visual studio code VS code download
• Postman Postman Download

Foi utilizado o Sanctum, para realizar autenticação e geração de token de acesso aos endpoints

Para realizar a autenticação, será necessário acessar o endpoint POST "http://127.0.0.1:8000/api/register", para registrar um novo usuário

Na aba body, escolha a opção raw e JSON, e insira os campos obrigatórios para se cadastrar

Todos os campos são obrigatórios, caso algum campo não seja inserido, a api irá retornar um erro

Campo confirmação de senha faltando

O e-mail, é um campo único no banco de dados. Não podendo ser repetido

A API irá mostrar os dados do usuário, ao ser realizada a requisição com os valores corretos

Para realizar o login para obter o token de acesso, o endpoint "http://127.0.0.1:8000/api/login", inserindo o dados de email e senha

O Token de acesso, estará disponível após a realização do login, na retorno de resposta da api

Após obter o token, será necessário copia-lo para a autorização. Na parte superior do Postman logo abaixo das requisições, há uma aba de Authorization. Clicando irá ter uma seleção de Auth Type. Escolha a opção Bearer Token, e cole o token no campo token logo ao lado

Após a realização da autenticação, os endpoints já estarão autorizados para acesso.

Caso o token não seja passado, ou esteja expirado. O acesso a API não será permitido

O acesso para logout é: http://127.0.0.1:8000/api/logout O logout será realizado com sucesso

O Método Get, realiza a busca todos os clientes

Após a execução, a api irá retornar o dados solicitado. Status Code 200 Success

Caso o ID não exista, o endpoint irá retornar o Status Code 404 Bad Request (Cliente não encontrado)

O método get/cliente/razao-social/{razaoSocial}, irá retornar todos os clientes a partir da razão social cadastrada.

O método Post, realiza a criação de um novo cliente, enviando dados através do corpo da requisição Todos os campos são obrigatórios. Após a execução, a api irá retornar os dados criados. Status Code 201 Created

Os campos contém validações no cadastro

Caso as informações não esteja de acordo com o esperado

Não é possível cadastrar um cliente com um e-mail ou CNPJ que já esteja na base de dados Exemplo de utilização de e-mail já cadastrado;

O método Put, irá atualizar o cliente, enviado dados através do corpo da requisição, e informando o id do cliente a ser atualizado. Necessário preenchimento de todos os campos para atualização Após a execução, a api irá retornar os dados atualizados. Status code 200 Success

Se algum dados forem passado fora das regras, o retorno será um erro de código 500

Caso o id não exista na base de dados, o retorno será o código 404

O método Delete, irá deletar um cliente do banco de dados através do id do cliente a ser deletado. Sendo uma operação irreversível. O retorno será o código 204, no content

• PHP
• Laravel
• MySQL
• Postman

• Maurício Marcelino - Back-End do projeto - Maurício Marcelino

Esse projeto está sob a licença (MIT) - acesse os detalhes LICENSE.md.