HomeAccessCenter API

Base API URL

The base URL for the HomeAccessCenter API is:

https://homeaccesscenterapi.vercel.app

Example API Request

Before making an API request, please note that passwords are not stored by the API. Refer to the Security section for more details.

To retrieve the name of a student, send a GET request to the following API endpoint:

GET https://homeaccesscenterapi.vercel.app/api/name?link=https://homeaccess.katyisd.org/&user=D1234567&pass=Doe123!

Replace the placeholders in the query parameters (link, user, and pass) with the actual URL to the Home Access Center (HAC) website, your HAC username, and your HAC password respectively.

Example API Response

A successful API response will be in JSON format and will include the student's name:

{
  'name': "John Doe"
}

Behind the Scenes

The HomeAccessCenterAPI follows a series of steps to retrieve student information from the Home Access Center (HAC) servers:

1. Authentication: The API sends HTTP POST requests to the HAC servers, providing a username and password for authentication.

2. Login Validation: HAC validates the provided credentials and responds with an HTML page containing the student's information if the login is successful.

3. HTML Parsing: The API utilizes a Python package to parse the received HTML page and extract the requested information from the markup.

By following this process, the HomeAccessCenterAPI provides a streamlined and efficient way to retrieve student data from the Home Access Center.

Security

The HomeAccessCenterAPI prioritizes the security and privacy of user information. Here are the key security measures implemented:

1. No Database Storage: User information is not stored in any databases. Once a request has been processed, all associated data is immediately discarded, preventing data breaches or unauthorized access.

2. Secure Data Transmission: All communication between the API and the HAC servers occurs over HTTPS, utilizing encryption (TLS/SSL) to safeguard the confidentiality and integrity of data transmitted over the network.

3. Minimal Data Retention: The API only retains the necessary data during the processing of a request. Once the response has been generated and sent back to the user, all temporary data related to the request is promptly erased.

By adhering to these security practices, the HomeAccessCenterAPI ensures that user information remains protected throughout the data retrieval process.