API Portal and Gateway for HKUST Systems

william wan, Head of Teaching Technologies

The Application Programming Interface (API) is a generic term referring to the software connection standard that allows different systems to work with each other using mutually agreed protocols, message formats and security control setup. 

API has evolved from application specific approach by connecting two systems in a tailor-made and secretive manner, to a standardized approach which allows a wide variety of authorized clients to consume. A common approach is to componentize services and data based on RESTful API technology together with open standards e.g. JSON, Open ID connect and OAuth. Most of the mobile app and modern web applications are using this approach to segregate the “front-end user interface” and the “back-end system and data logic”

Currently, some systems in the University were developed with API connectivity. However, there is no one stop shop to look for all available APIs and the corresponding approval process for the use of those APIs. In view of this, ITSC is collaborating with different departments, offices and stakeholders to build an API infrastructure for the University.  Currently, two major components are implemented:

API Portal

  • API Portal serves as the one-stop shop for API exposed by all University systems, with
    • API Technical Standards
    • Data and Business Owners
    • API Specifications / Documentations
    • Registration & approval process for using the API

API Gateway

  • API Gateway serves as a single point of entry for campus APIs and guards against unauthorized access within or outside campus
    • Controls the volume and frequency of access to APIs
    • Enables analytics of API uses
    • Supports a variety of authentication / authorization mechanism like OIDC and OAuth
    • Supports proxying of cloud-based APIs

We are in the final stage of setting up the API Portal and API Gateway. There will shortly be a pilot launch of the platform. Initially, APIs including PathAdvisor, Event Calendar and some cloud-based services like Canvas, Qualtrics, etc. will be put under the API Portal / Gateway for users to access. More details will be provided after the launch of the service.

You are welcome to contact us at cchelp@ust.hk if there is any API useful for the community that you would like to publish.

prev
next