Bus Queue API

Background

Knowing the current general waiting time and crowdedness at the bus stops would help time management and reduce unproductive queueing time. We offer Wi-Fi analytics for smart crowd management. Our solution employs Wi-Fi analytics technology to understand the waiting time of people at our bus stops at both north and south gates. Wi-Fi sensors, which are SmartAPs, are installed in the bus stops. We can get the queue lengths (in terms of the number of people) and waiting time in real-time. The API provides the number of people queueing and waiting time at the north gate and south gate bus stops.

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/5f9a436fa4801500011a3675/request

API Documentation

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

Navigation