Sustainable Smart Campus API

Background

The University has announced the HKUST 2028 Sustainability Challenge and it will focus on 4 areas: Operations, Education, Community and Demonstration. Waste and water are parts of the 5 goals in Operations. For waste, the target is to reduce waste to the landfill by 75% compared to the 2014 baseline year by 2028. For water, the target is to limit potable water consumption to less than 500,000 cubic meter by 2028. The water, recyclables and food waste data is collected from water bill and different contractors on a monthly basis. The visualized data allows campus users to understand the operation performance and the progress towards the 2028 Sustainability Challenge.

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 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 data. https://itsc.ust.hk/services/it-infrastructure/smart-campus-infrastructure/open-data-platform

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/608933017b7525000140eacc/request

API Documentation

You can find the API documentation here https://hkust.cloud.tyk.io/portal/apis/60a22cdeca74b80001d85ca1/documentation/

Navigation