/APIContratos

API criada para manipular contratos, usando Django e bd mysql

Primary LanguagePython

API Contratos

Descrição do Projeto

API elaborada para gerenciar contratos e o envio de documentos

🔗 Django

Python framework para agilizar o desenvolvimento

🔗 Django Rest Framework

Toolkit para construção de web APIs

Features

  • Cadastro de contratos
  • Cadastro de documentos
  • Delete contratos
  • Update contratos
  • Update de documentos
  • Delete documentos

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

Documentação

POST Adicionar Contrato

api/addContrato

Parâmetro Descrição
nome (Obrigatório) nome do contratante VARCHAR
email (Obrigatório) email do contratante VARCHAR
CPF (Obrigatório) CPF do contratante VARCHAR
Renda (Obrigatório) Renda do contratante FLOAT
Rua (Opcional) Rua onde o contratante mora VARCHAR
Numero (Opcional) Número onde o contratante mora INT
Bairro (Opcional) Bairro onde o contratante mora VARCHAR
Cidade (Opcional) Cidade onde o contratante mora VARCHAR
Estado (Opcional) Estado onde o contratante mora, formato (RJ, SP...) VARCHAR
Estado Civil (Opcional) Estado civil do contratante VARCHAR
Data de Nascimento (Opcional) Data de nascimento do contratante DATE
Valor (Obrigatório) Valor do contrato FLOAT

Content-Type application/json

Exemplo Request

{ "nome": "Daiane", "email": "teste@teste.com.br", "cpf":"21333333333", "renda":1000, "valor": 20000 }

Exemplo Response

{ "Contrato": { "id": 5, "valor": 20000.0, "status": [ 1, "criado" ], "usuarioId": 13, "statusAprovacao": "" }, "User": { "id": 13, "nome": "Daiane", "email": "teste@teste.com.br", "cpf": "21333333333", "renda": 1000.0, "rua": "", "numero": 0, "bairro": "", "cidade": "", "estado": "", "estadoCivil": "", "dataNascimento": "2020-10-14" } }


GET Contrato

api/contrato/id

Requisições PUT e DELETE seguem o mesmo modelo

Exemplo Response

{ "contrato": { "id": 1, "valor": 300.0, "status": 1, "usuarioId": 9, "statusAprovacao": "" }, "usuario": { "id": 9, "nome": "Daiane", "email": "teste@teste.com.br", "cpf": "21333333333", "renda": 1000.0, "rua": "", "numero": 0, "bairro": "", "cidade": "", "estado": "", "estadoCivil": "", "dataNascimento": "2020-10-13" } }

POST Adicionar Documento

api/addDoc

Parâmetro Descrição
tipo (Obrigatório) nome do contratante VARCHAR
email (Obrigatório) Tipo do Documento a ser inserido INT (1: CPF, 2:CNH)
CPF (Obrigatório) CPF do contratante VARCHAR
Imagens (Opcional)URL das fotos dos documentos VARCHAR
Comprovante de Renda (Opcional) URL das fotos do comprovante de renda VARCHAR
ContratoID (Obrigatório) id do contrato referente a adição do documento INT

Content-Type application/json

Exemplo Request

{ "tipo": 1, "urlimagens": "https://www.google.com.br/", "urlcomprovanteRenda":"https://www.google.com.br/", "contratoId":1 }

Exemplo Response

{ "id": 1, "tipo": [ 1, "CPF" ], "urlimagens": "https://www.google.com.br/", "urlcomprovanteRenda":"https://www.google.com.br/", "contratoId":1 } }


POST Analisar Documento

api/analisaContrato/idContrato

Parâmetro Descrição
Resultado (Obrigatório) Status aprovação do contrato (1:'aprovado') (2:'rejeitado') INT

Content-Type application/json

Exemplo Request

{ "aprovacao": 1 }

Exemplo Response

{ "contrato": { "id": 1, "valor": 300.0, "status": 1, "usuarioId": 9, "statusAprovacao": 1 }, "usuario": { "id": 9, "nome": "Daiane", "email": "teste@teste.com.br", "cpf": "21333333333", "renda": 1000.0, "rua": "", "numero": 0, "bairro": "", "cidade": "", "estado": "", "estadoCivil": "", "dataNascimento": "2020-10-13" } }