API de Tarefas - Unibalsas 📒

Esta é uma API de busca de tarefa na UB Virtual, plataforma da faculdade onde é postada as atividades. Ela permite que você recupere e se mantenha atualizada as atividades do portal, além de outros pontos como dados dos usuários e cursos. Hospedada provisoriamente para outros projetos em https://ub-task-api.vercel.app/.

Projeto Reestruturado e Escalavel. 😎📱

Swagger 📑

Perfil 🙍

Tarefas 📚

Recursos da API 🔨

• Home: Dá as suas Boas-Vindas e traz informações relevantes sobre a API e Contatos.
• Docs: Local para aprender sobre a API e como utilizar de forma interativa e dinâmica.
• Task: Verifica se há tarefas e as retornas, como nome da matéria e da atividade, data de entrega e link da atividade.
• Profile: Verifica o perfil e retorna os dados visíveis do usuário, como nome e até e-mail.

Site Universitario para apresentação da instituição Unibalsas

Principais Tecnologias Utilizadas 🌐

• Flask: Framework utilizado para o desenvolvimento de aplicações web, proporcionando uma estrutura flexível e eficiente para a criação de APIs e interfaces de usuário.
• Python: Linguagem de programação principal, escolhida pela sua versatilidade, simplicidade e vasta comunidade de desenvolvedores.
• Request: Biblioteca utilizada para realizar requisições HTTP, facilitando a comunicação com APIs externas e a obtenção de dados online.
• BS4: Beautiful Soup, uma biblioteca em Python utilizada para fazer web scraping, permitindo a extração de informações de páginas HTML e XML de forma fácil e intuitiva.
• Cerberus: Biblioteca de validação de dados em Python, empregada para garantir a integridade e consistência dos dados manipulados pela aplicação.
• Outras Bibliotecas: O resto das bibliotecas pode ser encontradas no requirements.txt, incluindo diversas ferramentas e utilitários que complementam e aprimoram as funcionalidades da aplicação.

Documentação 📃

Acesse a documentação da API para obter informações detalhadas sobre os endpoints, parâmetros e testes de requisições.

A aplicação funciona assim: Quando a API receber uma solicitação URL com tal função, seja por GET ou POST, ela executa as funções conforme a rota pre-estabelecida, realiza o login e realiza uma busca a estrutura do site bruta, retornando uma resposta em formato JSON.

Como usar 💁‍♀️

1. Rota principal ("/"): Retorna um JSON com informações sobre a API.
   (https://ub-task-api.vercel.app)

{
  "contact": {
    "email_personal": "pedro.henrique.martins404@gmail.com",
    "email_academic": "pedro.borges@alu.unibalsas.edu.br",
    "github": "piedro404",
    "linkedin": "pedrohenrique404"
  },
  "documentation": "/docs",
  "endpoints": {
    "home": "/",
    "ub": {
      "ub_profile": "/ub/profile",
      "ub_task": "/ub/task"
    }
  },
  "message": "Welcome to the UB API!",
  "status": true,
  "version": "3.0v"
}

2. Rota de Tarefas ("/ub/task"): Recebe a matricula/email(login) e senha(password) que deverá se enviada no body de uma requisição por POST e retorna um JSON com o resultado da pesquisa das tarefas.
   (https://ub-task-api.vercel.app/ub/task)

{
  "status": true,
  "tasks": {
    "amount_task": 1,
    "description": "Há 1 atividade(s) pendente(s)!",
    "find_task": true,
    "list_tasks": [
      {
        "date": "6 março",
        "day_week": "quarta-feira",
        "matter": "LABORATÓRIO DE SISTEMAS OPERACIONAIS",
        "task_name": "Atividade - Mapa Conceitual sobre Sistemas de Arquivos (até 06/03) está marcado(a) para esta data",
        "time_limit": "18:59 PM",
        "url_task": "https://ead.unibalsas.edu.br/mod/assign/view.php?id=16236"
      }
    ]
  }
}

3. Rota de Perfil ("/ub/profile/"): Recebe a matricula/email(login) e senha(password) que deverá se enviada no body de uma requisição por POST e retorna um JSON com o resultado da pesquisa do perfil.
   (https://ub-task-api.vercel.app/ub/profile)

{
  "profile": {
    "email": "augustomatheus233@gmail.com",
    "language": "português",
    "name": "Matheus Augusto Silva Dos Santos",
    "user_initials": "MA",
    "user_picture": "https://ead.unibalsas.edu.br/user/pix.php/2228/f1.jpg"
  },
  "status": true
}

Todas as resposta acima são de Status Code de 200. Veja a Documentação para poder capturar outros Status Codes como 400, 401, 422 e 500.

Como Executar o Projeto Localmente 🛠️

1. Clone este repositório:

   git clone https://github.com/piedro404/ub-task-api.git

2. Ambiente Virtualizado (Opcional) Para organização e facilitar em rodar o projeto, sugiro criar um ambiente virtualizado. Para isso, basta usar o comando abaixo:

  python -m venv .venv

  .venv\Scripts\activate

3. Instale as dependências:

   pip install -r requirements.txt

4. Execute a aplicação:

   python run.py

Sobre 📒

Obrigado a todos, desejo ótimos estudos, caso queira, entre em contato em pedro.henrique.martins404@gmail.com;