-
Notifications
You must be signed in to change notification settings - Fork 1
Home
The Gateway Building Block (Gateway BB) provides a simple interface between the Illinois App and external services that provide student data for various functions. The Gateway Building Block is in development, but currently provides interfaces to the following types of data:
The laundry and wayfinding end points require a Core BB access token passed in the Authorization header as a bearer token and use the core auth library to authenticate the tokens. The contact/emergency contact data end point requires both the Core BB access token and require an external OIDC access token from the authentication server. That token is passed to the building block as the value of an "External-Authorization" header. The building block passes that token on to the data end points where the student identifier claim is verified before the data is returned to the building block.
The Gateway Building block utilizes a vendor supplied API to provide laundry room locations and configurations, machine availability and problem reporting capabilities. Currently the interface for querying laundry data is only implemented for the api end points provided by CSC.
The vendor exposes two service to the gateway building block. The first allows the building block to retrieve a list of all laundry rooms on campus and to return a summary of the machines and their availability in a specific room. Details on the data returned by the building block can be found at the online documentation for the rooms and the room detail end points.
The second service provides the ability to interact with the vendor system to report problems with the laundry machines. The building block provides two end points to be used in the process. The Init Service end point initializes the request, returning the information required to submit a ticket. Following that, a request is made to the Request Service end point to attempt the actual submission.
To support wayfinding efforts, the Gateway Building Block provides access to campus building data, including the locations of the buildings and all of their entrances. This data can be retrieved from the buildings endpoint. The closest entrance to a building can be found using the entrance endpoint.
The Gateway BB provides access to student contact and emergency contact information through the contact info endpoint. This endpoint must be passed a valid OIDC Access Token in the External-Authorization header. It will then provide the contact information for the associated user.