Q-scraper

Uma ferramenta para realizar o web-scraping dentro da plataforma Q-acadêmico.

Descrição

Q-scraper é um web-scraper para obter informações contidas na plataforma Q-Acadêmico, utilizando o protocolo HTTP, retornando um JSON com as informações solicitadas. O objetivo principal desse projeto é possibilitar a obtenção dos dados acadêmicos sem que seja necessário o acesso ao sistema em questão.

Pré-Requisitos

• Docker
• Docker-compose

Utilização

O serviço ainda não está disponível! :/

Instalação/Execução

Configurando o Docker

Construindo a imagem

$ docker-compose build

Executando o container

$ docker-compose up -d 

Após a execução dos comandos, o servidor estará disponível em localhost:3000/

ENDPOINTS

Endpoint	Descrição
GET /grades	Retorna uma coleção com as notas obtidas em atividades/provas.
GET /scores	Retorna uma coleção com as notas finais obtidas ao final do semestre.
GET /learning_materials	Retorna uma coleção com todos os materiais de aula disponibilizados pelas disciplinas.
GET /me	Retorna uma coleção de dados pessoais do usuário.

GET /grades

1. Parâmetros

Nome	Obrigatório	Descrição	Exemplo
Matrícula	Obrigatório	Conjunto de números utilizado como identificação do estudante na instituição.	2014103202030000
Senha	Obrigatório	Coleção de caracteres de segurança para utilização do Q-Acadêmico.	1SenhaT0talmenteS3gura

2. Resposta

[
    {
        "nome": "Programação para Dispositivos Móveis",
        "avaliacao": [
            {
                "descricao": "Nota Semestral",
                "peso": "1",
                "notaMaxima": "10",
                "notaObtida": "10"
            }
        ]
    },
    {
        "nome": "Segurança e Auditoria da Informação",
        "avaliacao": [
            {
                "descricao": "Atividades - ameaças",
                "peso": "1",
                "notaMaxima": "2.5",
                "notaObtida": "2.5"
            },
            {
                "descricao": "Tipos de ameaças",
                "peso": "1",
                "notaMaxima": "5",
                "notaObtida": "5"
            }
        ]
    }
]

GET /scores

1. Parâmetros

Nome	Condição	Descrição	Exemplo
Matrícula	Obrigatório	Conjunto de números utilizado como identificação do estudante na instituição.	2014103202030000
Senha	Obrigatório	Coleção de caracteres de segurança para utilização do Q-Acadêmico.	1SenhaT0talmenteS3gura

2. Resposta

[
    {
        "nome": "Teste de Software",
        "nota": "10,0",
        "status": "Aprovado",
        "faltas": "4"
    },
    {
        "nome": "Programação para Dispositivos Móveis",
        "nota": "10,0",
        "status": "Aprovado",
        "faltas": "4"
    }
]

GET /learning_materials

1. Parâmetros

Nome	Condição	Descrição	Exemplo
Matrícula	Obrigatório	Conjunto de números utilizado como identificação do estudante na instituição.	2014103202030000
Senha	Obrigatório	Coleção de caracteres de segurança para utilização do Q-Acadêmico.	1SenhaT0talmenteS3gura

2. Resposta

[
    {
    "subject": "Trabalho de Conclusão I",
    "documents": [
      {
        "date": "17/02/2020",
        "link": "https://academico.ifgoiano.edu.br/cefetweb-uploads/MATERIAIS_AULAS/341005-NORMAS-DE-TC-DOS-CURSOS-DE-GRADUAO-DO-IF-GOIANO-CERES---Aprovado-via-Ordem-de-Servio-66-2019-e-para-publicao.pdf",
        "title": "Regulamento de TC"
      }
    ]
  }
]

GET /me

1. Parâmetros

Nome	Condição	Descrição	Exemplo
Matrícula	Obrigatório	Conjunto de números utilizado como identificação do estudante na instituição.	2014103202030000
Senha	Obrigatório	Coleção de caracteres de segurança para utilização do Q-Acadêmico.	1SenhaT0talmenteS3gura

2. Resposta

{
  "name": "Alexandre Ferreira Lopes",
  "course": "Sistemas de Informação",
  "general_coefficient": "9.21",
  "compulsory_workload": "2440",
  "completed_compulsory_workload": "2220",
  "total_workload": "3120",
  "completed_total_workload": "2340"
}

Licença

MIT