Getting Started

This page provides an overview of how to install and begin using the jsjiit library. It covers prerequisites, the basic workflow for integrating jsjiit into your application, and the fundamental concepts you need to understand before making API calls to the JIIT Web Portal.

For detailed installation instructions across different environments, see Installation. For working code examples and hands-on tutorials, see Quick Start Guide.

Purpose and Scope

The jsjiit library is a browser-compatible JavaScript wrapper for the JIIT (Jaypee Institute of Information Technology) Web Portal. It enables programmatic access to portal features including attendance tracking, grade retrieval, exam schedules, and academic records. The library handles authentication (including CAPTCHA bypass), request encryption, and response parsing automatically.

This page covers:

• Prerequisites - Requirements for your development environment
• Distribution Options - Where and how to obtain the library
• Core Concepts - The main classes and workflow
• Initial Setup - Your first interaction with the library

For detailed API method documentation, see API Reference. For architecture and implementation details, see Architecture and Design.

Prerequisites

Runtime Environment

The jsjiit library requires a modern browser environment with ES2020+ support. Specifically:

Sources: package.json1-61 README.md1-113

Development Dependencies

If you plan to build from source or contribute to the library, you will need:

Note: These are only required for library development. End users who import the pre-built bundles do not need these dependencies.

Sources: package.json57-60

Distribution and Entry Points

The jsjiit library is distributed through multiple channels, each serving different use cases:

Distribution Entry Points

Sources: package.json5-8 package.json22-25 README.md23-24

Package Configuration

The package.json5-8 defines multiple entry points to support different import scenarios:

Note: All entry points resolve to the same ES module bundle. The library uses package.json8 "type": "module" to indicate it is ES module-based.

Sources: package.json5-8 package.json22-25

Core Workflow

The typical workflow for using jsjiit follows this sequence:

Workflow Phases

Sources: README.md23-96 src/index.js1-8

1. Import Phase

You import the WebPortal class from the distributed bundle. The library exports this class from src/index.js1-8 which re-exports from src/wrapper.js

Example import statement from README.md23-24:

import { WebPortal } from 'https://cdn.jsdelivr.net/npm/jsjiit@0.0.23/dist/jsjiit.min.esm.js';

2. Instantiation Phase

Create a new instance of the WebPortal class:

const portal = new WebPortal();

At this point, no network requests have been made. The instance is ready to authenticate.

3. Authentication Phase

Call the student_login() method with credentials:

await portal.student_login('your_username', 'your_password');

This method:

• Bypasses the CAPTCHA requirement
• Encrypts the credentials using AES-CBC encryption
• Establishes an authenticated session
• Returns a WebPortalSession instance

4. Data Retrieval Phase

Once authenticated, use the session methods to retrieve data:

const meta = await portal.get_attendance_meta();
const grades = await portal.get_grade_card(semester);
const exams = await portal.get_exam_events(semester);

All data exchange with the portal is encrypted and automatically handled by the library.

Sources: README.md32-96

Core Classes and Module Structure

The library exposes several classes through src/index.js1-8 Understanding their relationships helps you use the library effectively:

Primary Classes

Sources: src/index.js1-8 src/wrapper.js src/attendance.js src/registration.js src/exam.js src/exceptions.js src/feedback.js

WebPortal Class

Defined in src/wrapper.js this is your initial entry point. The WebPortal class has a single primary method:

• student_login(username, password) - Authenticates with the portal and returns a WebPortalSession instance

WebPortalSession Class

Also defined in src/wrapper.js this class contains all methods for retrieving data from the portal after authentication. Key method categories include:

For complete method documentation, see API Reference.

Domain Model Classes

These classes represent structured data returned by API methods:

• AttendanceMeta src/attendance.js - Container for attendance headers and semesters
• AttendanceHeader src/attendance.js - Represents an attendance period
• Semester src/attendance.js - Represents an academic semester
• RegisteredSubject src/registration.js - Information about a registered course
• Registrations src/registration.js - Collection of registered subjects
• ExamEvent src/exam.js - Exam event information

For detailed documentation of these models, see Data Models.

Exception Classes

Defined in src/exceptions.js these custom exceptions provide specific error handling:

• InvalidCredentialsException - Authentication failed
• WebPortalException - General portal errors
• PasswordTooShortException - Password validation error
• Additional exception types for various error scenarios

For error handling strategies, see Error Handling.

Sources: src/index.js1-8 src/wrapper.js src/attendance.js src/registration.js src/exam.js src/exceptions.js

Installation Overview

The jsjiit library can be installed through multiple methods depending on your project structure:

Installation Method Selection

Sources: README.md23-24 package.json1-61

Quick Installation Reference

For complete installation instructions including environment-specific setup, see Installation.

Sources: README.md23-24 package.json2-3

Basic Usage Pattern

Here is the minimal code required to authenticate and retrieve data from the portal:

// 1. Import the WebPortal class
import { WebPortal } from 'https://cdn.jsdelivr.net/npm/jsjiit@0.0.23/dist/jsjiit.min.esm.js';

// 2. Create a WebPortal instance
const portal = new WebPortal();

// 3. Authenticate (all subsequent operations require this)
await portal.student_login('your_username', 'your_password');

// 4. Retrieve data
const meta = await portal.get_attendance_meta();
const sem = meta.latest_semester();
const header = meta.latest_header();
const attendance = await portal.get_attendance(header, sem);

console.log(attendance);

This pattern demonstrates:

• Import - Load the WebPortal class from the CDN
• Instantiation - Create a portal instance
• Authentication - Login with credentials
• Data Retrieval - Call session methods to get data

Important Notes:

1. All API methods after student_login() are asynchronous and must be await-ed
2. The code must run in a <script type="module"> context in browsers
3. Authentication must succeed before calling any data retrieval methods
4. The library handles encryption, decryption, and error handling automatically

For more comprehensive examples including error handling and multiple API methods, see Quick Start Guide.

Sources: README.md32-55

Security and Encryption

The jsjiit library implements AES-CBC encryption for all portal communications. As a user of the library, you do not need to handle encryption directly—it is managed transparently by the WebPortalSession class.

Key security features:

• Automatic encryption - All outgoing requests are encrypted using src/encryption.js
• Automatic decryption - All incoming responses are decrypted automatically
• CAPTCHA bypass - Authentication does not require manual CAPTCHA solving
• Credential security - Passwords are never sent in plaintext

For detailed information about the encryption implementation, see Encryption and Security.

Sources: README.md4 README.md13

Next Steps

After understanding the basic concepts on this page:

1. Installation - Follow detailed installation instructions for your specific environment
2. Quick Start Guide - Work through complete code examples with error handling
3. API Reference - Explore the full API surface and available methods
4. WebPortal Class - Deep dive into the main entry point class
5. Data Models - Understand the structure of returned data

Common Next Actions:

Sources: README.md1-113 package.json1-61