kaplan360-api

kaplan360-api is an unofficial REST API for the Kaplan360 mobile application. It is built using Node.js, Express.js, and uses ES6 syntax and Async-Await/Promise for code clarity and performance.

kaplan360-api offers a few key features:

• Intuitive API, we handle the complex multi-chaining OAuth2 and OpenAM/OpenIDM REST API for you. Built-in token refresh and error handling for OAuth2 Credentials and JWT expiry, no more finding error in a haystack.
• Extended Classroom Schedule, from the first session to last session!
• Generate iCalendar file format for your classroom schedule, easily import it to any calendar application! (coming soon)
• Extended Attendance Status, showing attendance information such as lowest, highest, and mean attendance rate for all available months! (coming soon)
• Robust Notifications API for viewing, search filtering, page and limit pagination, and sorting unread/archived. (coming soon)
• Pleasant RU(Read, Update) sub-resources routes for updating profile, changing password, creating a leave application, requesting a document, and many more! (coming soon)
• Totally asynchronous and non-blocking code, optimised for speed and performance.

Installation

Requirements

• macOS 10.9+ / Linux
• Node.js >=8 (6.x and 7.x may work but is no longer tested, please upgrade)

1. Create a folder to hold your installation: mkdir kaplan360-api
2. FTP/Copy the contents of the zip to your newly created folder
3. Enter folder: cd kaplan360-api
4. Install dependencies: npm install
5. Start application: npm start --production
6. Visit http://127.0.0.1:8888 in your browser

Keeping kaplan360-api running after closing the terminal can be done in a few ways but we recommend using the PM2 package. To set this up:

1. Install PM2: npm install pm2 -g
2. Add kaplan360-api to PM2: NODE_ENV=production pm2 start src/app.js --name "kaplan360-api"
3. Check PM2 has our app: pm2 list
4. Save the PM2 config: pm2 save
5. To start/stop: pm2 start kaplan360-api / pm2 stop kaplan360-api

Note: Node.js version 7.x or greater is needed.

Tests

npm test

API Documentation

Example Response

curl -X POST -H "Content-Length: 0" https://kaplan365.tk/api/session?username=CT1234567&password=supersecurepass

{
    "success": true,
    "payload": {
        "jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOIsImtpZCI6InpoQm9mYlp3K2prWlpqWHMyOGZHZnp4WmdNOD0ifQ.eyJ0b2tlbk5hbWUiOiJpZF90b2tlbiIsImF6cCI6ImthcGxhbjM2MCIsInN1YiI6IkNUMDI4NjImF0X2hhc2giOiJWNUJ6UmJOdng4NHdlbElVR0JHZnZ3IiwiaXNzIjoiaHR0cHM6Ly9sb2dpbi5rYXBsYW4uY29tLnNnOjQ0My9hdXRoL29hdXRoMiIsIm9yZy5mb3JnZXJvY2sub3BlbmlkY29ubmVjdC5vcHMiOiJlZGJiNGIyNi00YWFhLTRiYWYtYmViNy0wMmEyMGFhOTgxMDEiLCJpYXQiOjE1NjIzNzEyMDQsImF1dGhfdGltZSI6MTU2MjM3MTIwNCwiZXhwIjoxNTYyNzMxMjA0LCJ0b2tlblR5cGUiOiJKV1RUb2tlbiIsImF1ZGl0VHJhY2tpbmdJZCI6Ijc1Y2E2YTA5LWY5ZDEtNDg3My1iODViLTE0NWYyZmUyNmI2OS0zNDEyNDkwMCIsInJlYWxtIjoiLyIsImF1ZCI6ImthcGxhbjM2MCJ9.bSJ-kcaM-lEgAVRu_MgGHgB_SXmPTZlQJ0uQ7FtMRNBx6dI_-6dsTT10Xi6URP6eXXyn4W6DANGc7F8R6me40csfePcw3IsemK6zUPB_pA9CfboY2tz0bVdVk02rm-XqNwX0besfbGvaienTKAYqksGzdWnnA8vsP4UA8IbGoDTX7hyf5vDMC1nWuPIcEHt1RVa0yojs8B13T4cqHIgnJ1qGuQnPF9HQ1TaZY01425D7WH9NnrIpjYTpj4cP4OI_5azmD3-o-WkJbc_YVxA0VZ_ivLcGqZLtN1e4RdNekqezlTxj-pU_eGjuQxqFw-xSMp"
    }
}

Credits

Created and maintained by VEDDEV (@veddev0x).

License

kaplan360-api is available under the MIT license. See the LICENSE file for more info.