Skip to content

Latest commit

 

History

History
396 lines (321 loc) · 7.56 KB

README.md

File metadata and controls

396 lines (321 loc) · 7.56 KB
Raw

HCK API SERVICES 🎉🎉

Usages

  1. Open terminal
  2. git clone https://github.com/lamaparbat/HERALD-API-SERVER.git [ctrl & ctrl+v]
  3. cd HERALD-API-SERVER [ctrl & ctrl+v]
  4. npm install [ctrl & ctrl+v]
  5. npm run dev [ctrl & ctrl+v]

Kudos 🎉🎉. Good to go now 👏🏽👏🏽. Test api using postman.

API DESCRIPTION

Student endpoints

  1. Login
POST : /api/v4/student/Login

payload: {
   uid:"np03cs21@heraldcollege.edu.np"
}

****** -> Response  <- *******
onSuccess: {
  message: 'Login succesfull !!',
  email:"np03cs4s210869@heraldcollege.edu.np",
  scope:"student",
  accessToken:"s23241sfsdf.ad34fdsfdsdf.34sfgsfsfsfsd",
  refreshToken:"s23241sfsdf.ad34fdsfdsdf.34sfgsfsfsfsd",
}
onFailure: {
  message: 'Failed to login. Please use correct email !!',
  token: null,
}

Regenerated access token endpoints

PUT : /api/v4/RegenerateToken

header:{
  "Authorization": "refreshToken ${refreshToken}"
}

****** -> Response  <- *******
onSuccess: {
  message: 'Token regenerated succesfully !!',
  accessToken: accessToken,
  refreshToken: refreshToken
}
onFailure: {
  message:"Refresh token cannot verified."
}

Teacher endpoints

  1. Login
POST : /api/v4/teacher/Login

payload: {
   email:"",
   password:""
}

****** -> Response  <- *******
onSuccess: {
   message:"Login succesfully",
   email:"bishalkhadka32@gmail.com",
   scope:"teacher",
   accessToken:"s23241sfsdf.ad34fdsfdsdf.34sfgsfsfsfsd",
   refreshToken:"s23241sfsdf.ad34fdsfdsdf.34sfgsfsfsfsd",
}
onFailure: {
   message:"Failed to login",
   token:null
}
  1. Signup
POST: /api/v4/teacher/Signup

payload: {
   email:"",
   password:""
}

****** -> Response  <- *******
onSuccess: {
   message:"Account created succesfully",
   token:"s23241sfsdf.ad34fdsfdsdf.34sfgsfsfsfsd"
}
onFailure: {
   message:"Failed to create account !1",
   token:null
}

Admin endpoints

  1. Login
POST : /api/v4/admin/Login

payload: {
   email:"",
   password:""
}

****** -> Response  <- *******
onSuccess: {
   message:"Login succesfully",
   email:"nirmal55@gmail.com",
   scope:"admin",
   accessToken:"s23241sfsdf.ad34fdsfdsdf.34sfgsfsfsfsd",
   refreshToken:"s23241sfsdf.ad34fdsfdsdf.34sfgsfsfsfsd",
}
onFailure: {
   message:"Failed to login",
   token:null
}
  1. Signup
POST: /api/v4/admin/Signup

payload: {
   email:"",
   password:""
}

****** -> Response  <- *******
onSuccess: {
   message:"Account created succesfully",
   token:"s23241sfsdf.ad34fdsfdsdf.34sfgsfsfsfsd"
}
onFailure: {
   message:"Failed to create account !!",
   token:null
}

Routines CRUD endpoints

  1. Create routine
POST: /api/v4/admin/postRoutineData
 
//header.authorization.bearer
token: ""

// send data
payload: {
   courseType: string,
   moduleName: string,
   teacherName: string,
   classType: string,
   group: string,
   roomName: string,
   blockName: string,
   day: string,
   startTime: string,
   endTime: string,
   status: string
}

****** -> Response  <- *******
onSuccess: {
   message:"Routine posted successfully.",
}
onFailure: {
   message:"Failed to post the routine !!",
}
  1. Read/Fetched routine data
GET: /api/v4/routines
 
 //params || query
 group= 8  [For STUDENT = required  , For ADMIN & TEACHER = Optional ].    
 id = string     [Optional]
 //header.authorization.bearer
token: ""

****** -> Response  <- *******
onSuccess: {
   [
       {
          courseType: string,
          moduleName: string,
          teacherName: string,
          classType: string,
          group: string,
          roomName: string,
          blockName: string,
          day: string,
          startTime: string,
          endTime: string,
          status: string
        },
      ...
   ]
}

onFailure: {
    message: "500 INTERNAL SERVER ERROR !!"
}

Get the lists ongoing/running class routines details

GET: api/v4/routines/ongoing?group=:groupCode
params: group

response: [objects]
  1. Update routine data
PUT: /api/v4/admin/updateRoutineData

!! the token must be attached to the header =>  header.authorization.bearer
token: ""

payload: {
   courseType: string,
   moduleName: string,
   teacherName: string,
   classType: string,
   group: string,
   roomName: string,
   blockName: string,
   day: string,
   startTime: string,
   endTime: string,
   status: string
}


****** -> Response  <- *******
onSuccess: {
   message:"Routine successfully updated.",
}
onFailure: {
   message: "Internal Server Error !!"
}
  1. Delete routine data
DELETE: /api/v4/admin/deleteRoutineData?routineID=number

query: {
    routineID:""
}

****** -> Response  <- *******
onSuccess: {
   message:"Routine successfully deleted.",
}
onFailure: {
   message: "Internal Server Error !!"
}

### User feedback CRUD (Recently updated !!)
1. Post feeback 
```perl
POST: /api/v4/feedback/postFeedback
  
 //header.authorization.bearer
token: ""

 payload = {
            reportType:String,
            description:String,
            file:Object
           }
  1. Fetch feedbacks
GET: /api/v4/feedback/getFeedback
  
 //header.authorization.bearer
token: ""

 response = "data": [
                       {
                           "_id": "62a2de564582e52de9b8f891",
                           "reportType": "suggestion",
                           "description": "i am testing mode",
                           "file": "1654840918671-next.png",
                           "__v": 0
                       },
                   ]
  1. Delete feedbacks
DELETE: /api/v4/feedback/deleteFeedback?feedbackId=
  
 // query
 feedbackId = String
 
 //header.authorization.bearer
token: String

Notifications regarding each update on routine,..

  1. Get notificaitons
GET: /api/v4/getNotifications

// query
group: String

// headers
accessToken: Bear token

// success response
StatusCode: 200 (OK)
[
    {
        _id: String,
        message: String,
        group: String,
        createdOn: String
    }
]

// failure response
StatusCode: 400

Upload Data in Excellsheet form (Student List)

  1. Upload student excell sheet (Please donot upload file other than xlsx format)
POST: /api/v4/uploadStudentList
  
 //header.authorization.bearer
token: ""

//payload
file:[objects].         [NOTE: File extension must be xlsx and table field ordering must be like S.N. , Student ID, ....]

//success response
Status Code: 200. ok
message = Data extracted and import to DB successfully.

//error client side failure response
Status Code: 400
message = Please donot upload file other than xlsx

//error server side failure response
Status Code: 500
message = SERVER ERROR

Upcoming features 👷🏻

  1. Concurrency -> PM2 (cpu core utilization technique + Load balancing)
  2. Social media api sync (Public api + Scrapping [Alternatives])
  3. Auto scaling with Cloud Services
  4. CRON [Scheduler] !PRIORITY

Things need to optimize 🥷

  1. Aggregation Framework for data mapping
  2. Devops + AWS Serivice integration [Premium]
  3. Log tracing & Management [Premium]

Things accomplished untill now 👨‍🚀

  1. Routine Management System. [incl. Dynamic routine search ]
  2. Lost and Found services.
  3. User feedbacks.
  4. Role based Authentication.
  5. Isolated versioning and configs (Into Production & Development)
  6. System Security [Incl. Password Hashing (SHA256) (Secure Hash Algorithm), Data encapsulation ]
  7. Redis implementation completed. [TEST]
  8. Social Media api integration test. [e.g Fetch instragram posts]
  9. Overal optimization [max time]

Author: Parbat Lama

Happy Learning ✌️ Happy Coding 👨‍💻