Create Web API (Application Programming Interface)

Closed
Smart Net Zero
Toronto, Ontario, Canada
Chief Automation Architect
2
Project
Academic experience
120 hours per learner
Learner
Anywhere
Advanced level

Project scope

Categories
Software development
Skills
application programming interface (api) communication home automation authentications communications protocols authorization (computing) research non-disclosure agreement (intellectual property law)
Details

The primary goal of the project is to create one Web API (Application Programming Interface) that enables seamless communication between specific Home Automation Hub platform and a specific device produced by a vendor. Time permitting, student can work on additional API on other device(s) manufactured by the same vendor.


There is a potential consideration for implementing direct integration within the Home Automation Hub platform to directly support and communicate with the vendor's devices, if deemed beneficial. Provide recommendation as needed.



Deliverables

The student will need to complete source code for generating the web API and include flow chart or step by step documentation process for creating the Web API.


In addition undertake the following tasks:

NDA:

  • Non-Disclosure Agreement will be required to be signed prior to the commencement of the project.


Vendor Device Research:

  • Investigate the vendor's documentation and APIs for their device.
  • Understand the communication protocols, data formats, and capabilities offered by the vendor's device.


Web API Development:

  • Design and implement a Web API that exposes endpoints for device discovery, control, and status retrieval.
  • Prioritize security considerations, implementing proper authentication and authorization mechanisms.


Test Web API:

  • Perform thorough testing to ensure the reliability and stability of the Web API.
  • Verify that the API functions correctly with representative device from the vendor.


Direct Integration Investigation:

  • Research the Home Automation Hub platform's capabilities for direct integration.
  • Understand the hub's plugin or integration framework and guidelines.
  • Assess the feasibility of developing a direct integration with the hub for enhanced native support.


Mentorship

Staff Guidance:

  • Regular Check-ins: Scheduled meetings or check-ins to discuss progress, address concerns, and provide guidance on overcoming challenges.


Home Automation Hub Platform Access:

  • Hub Platform Credentials: Access to the Home Automation Hub platform for testing and integration purposes.
  • Documentation: Comprehensive documentation for the Home Automation Hub platform's APIs and integration guidelines.


Networking and IoT Devices:

  • Access to Device: Provision of simulated or actual IoT devices for testing purposes.
  • Networking Environment: Access local network environment to simulate device communication.


Community Support:

  • Access to Forums and Communities: Encouraging learners to participate in relevant online forums, communities, or discussion groups for additional support and networking.


Supported causes
Sustainable cities and communities

About the company

Company
Toronto, Ontario, Canada
2 - 10 employees
Energy, Environment, Technology

Smart Net Zero is a โ€˜social enterpriseโ€™ of StraNexus, a firm that has been around for 20 years. We are pioneers in Social Lifestyle Automation, revolutionizing the way homes function and connect with their residents. We use carefully researched and customized technology to make homes do good things for the people and the planet.