HKUST IoT

Background

HKUST has developed a set of IoT (Internet of Things) services that are available for students and researchers at the University to experiment with IoT devices, smart applications and real-time data analytics, and provides a robust and secure IoT platform. The API provide functionality for IoT applications to retrieve the data out for their use.

HKUST provides networks for connecting IoT Devices, those are LoRaWAN Network, 5G, Campus Wi-Fi Network and Campus Wired Network. Any HKUST staff member or student are eligible to use those ntework to connect IoT Devices for studying or researching. For more information on how to connect the network, follow below links to know more in detail. https://itsc.ust.hk/services/it-infrastructure/smart-campus-infrastructure/iot-communication

The Sensor Data are sent from different types of sensor device e.g. temperature, hudmidity, CO2, water leakage, power meter ..etc. Those sensor devices are sponsored by different owners listed in below: LoraWAN iot network sensors (owner: FMO, ITSC) https://itsc.ust.hk/services/it-infrastructure/smart-campus-infrastructure/iot-communication/lorawan-iot-network-services/lorawan-sensor-type

Access Control

An authorization key will be required to access the API. Developer require to register a developer account at the API portal and request for an authorization key before accessing to the API. The authorization key will need be renewal each year to tighten security.

The iot data is stored in Open Data Platform supported by Elastic Stack. The Elastic Stack supports authorization by users and roles. It also supports multitenancy and granular access control to protect the iot data. https://itsc.ust.hk/services/it-infrastructure/smart-campus-infrastructure/open-data-platform

To protect Data Privacy, some of the iot data field would be anonymize or not shown to align with the University Data Privacy Policy Statement. If Developers need to access those sensitive data, a special Request for Confidential Information and Non Disclosure to thrid party Agreement with departmental head approval would be required.

In order to prevent snooping, tampering and sniffing, the data is encrypted with SSL/TLS in the network transmission and rate limit of 1000 calls per minute is applied.

Undertaking for access

Before using the API, developer must read, agree with and accept the below terms of Agreement. If the developer doesn’t accept the terms of Agreement and shall not accept to be bound by all the terms of this Agreement, they should stop using the API immediately.

Acceptable Use Policy https://itsc.ust.hk/it-policies-guidelines/aup

University Data Privacy Policy Statement https://dataprivacy.ust.hk/university-data-privacy-policy-statement

Apply for access

Register a API portal account, view the documents and request for an API key if you want to utilize the API.

Developer should need to state which type of data want to request and the purpose when submit the request. The submitted request will be processed and consult the data owner to get the approval. Once approve, an email with the authorization key will be sent to your account, you can start using the API to retrieve the data.

Request for a key: https://api.ust.hk/portal/member/policies/5d883df509920b0001bb2e60/request

API Documentation

You can find the API documentation here https://api.ust.hk/portal/apis/5f2d2e0d9b27c00001832cff/documentation/

Navigation