Overview

Vcademia, an unofficial REST API, offers streamlined access to the SRM Academia portal through a Python and Flask-based system. Hosted on Vercel, the API provides endpoints for retrieving course details, student information, attendance records, marks data, timetable specifics, and calendar details. The entire project is openly accessible on GitHub, featuring Swagger documentation for easy reference. Authentication is implemented through headers using access keys and deployment is automated using GitHub Actions.

Objective:

The objective of this project is to provide a REST API to access SRMIST' Academia portal. The API provides endpoints to retrieve course details, student details, attendance details, marks details, timetable details and calendar details.

Demo

API Endpoint: https://vcademia.api.vishok.tech/

Features

• Access to the following from Academia Portal:

  • Login (Auth)
  • Course details
  • Student details
  • Attendance details
  • Marks details
  • Timetable

• Swagger Documentation

Documentation

API Documentation is available at: https://vcademia.api.vishok.tech/

Usage/Examples

1. To obtain access code of a user:

   curl -X POST "http://localhost:5000/key" -H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "user=netid&pass=password"
   

   1. To obtain data from other endpoints: #curl -X GET "http://localhost:5000/<endpoint>" -H "accept: application/json" -H "x-access-token: accesskey"

Built With

• python