Skip to content

🔥RESTful API with TypeScript, Node.js, MongoDB, Express, integrated with a full-stack microservice using React and Next.js, deployed on AWS.

Notifications You must be signed in to change notification settings

Gustavonobregab/api-contratei

Repository files navigation

API Contratei

API profissional para geração de contratos imobiliários com IA.

🚀 Tecnologias

  • Node.js
  • Express
  • TypeScript
  • MongoDB
  • OpenAI API
  • AWS S3
  • JWT Authentication

📋 Pré-requisitos

  • Node.js 18+
  • MongoDB
  • Conta na AWS (para S3)
  • Chave da API OpenAI

🔧 Instalação

  1. Clone o repositório
git clone https://github.com/seu-usuario/api-contratei.git
cd api-contratei
  1. Instale as dependências
npm install
  1. Configure as variáveis de ambiente
cp .env.example .env

Edite o arquivo .env com suas configurações.

  1. Inicie o servidor em modo desenvolvimento
npm run dev

📚 Documentação da API

Autenticação

POST /api/auth/login

Login do advogado

{
  "email": "[email protected]",
  "senha": "senha123"
}

GET /api/auth/me

Retorna o perfil do advogado autenticado

Corretores

POST /api/corretores

Cadastrar novo corretor

{
  "nome": "Nome do Corretor",
  "cpf": "123.456.789-00",
  "telefone": "(11) 99999-9999"
}

GET /api/corretores

Listar corretores do advogado

GET /api/corretores/:id

Ver dados de um corretor específico

PUT /api/corretores/:id

Atualizar dados do corretor

GET /api/corretores/:id/contratos

Listar contratos vinculados ao corretor

Contratos

POST /api/contratos

Criar novo contrato

{
  "nome_personalizado": "Contrato de Locação - Apartamento Centro",
  "tipo": "locacao",
  "dados_estruturados": {
    "locador": {
      "nome": "Nome do Locador",
      "cpf": "123.456.789-00"
    },
    "locatario": {
      "nome": "Nome do Locatário",
      "cpf": "987.654.321-00"
    },
    "imovel": {
      "endereco": "Rua Exemplo, 123",
      "valor": 2000
    }
  }
}

GET /api/contratos

Listar contratos (com filtros)

GET /api/contratos/:id

Ver detalhes de um contrato

PUT /api/contratos/:id/observacao

Atualizar observação para IA

PUT /api/contratos/:id/dados

Atualizar dados estruturados

POST /api/contratos/:id/gerar

Gerar texto do contrato com IA

GET /api/contratos/:id/download

Baixar contrato em .docx

PATCH /api/contratos/:id/finalizar

Marcar contrato como finalizado

🤝 Contribuição

  1. Faça o fork do projeto
  2. Crie sua Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit suas mudanças (git commit -m 'Add some AmazingFeature')
  4. Push para a Branch (git push origin feature/AmazingFeature)
  5. Abra um Pull Request

📝 Licença

Este projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

About

🔥RESTful API with TypeScript, Node.js, MongoDB, Express, integrated with a full-stack microservice using React and Next.js, deployed on AWS.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published