Authenticated Web App Tile Component Architecture
Here is a component architecture diagram followed by an explanation of how each of the different components work together to ensure the authenticated web app tile is functional. See the key term section for an explanation of each component.
Â
The
Ready Mobile App
negotiates an external user token with theReady Servers
. This token will be used later by your application's backend to get the specific user's information (see step 4/5).When a user clicks your tile, the
Ready Mobile App
will load yourCampus Web App
. Your web app must use the followingReady JS-SDK
library to fetch theuser token
.Link to the
Ready JS-SDK
documentation: https://gitlab.com/ready-education-public/ready-integration-js
The
Campus Web App
will use theReady JS-SDK
to get theUser token
and send it to yourInstitution Servers
. (All calls by theCampus Web App
must include theUser token
).The
Institution Servers
queries theReady Platform API
with theSession Key
as a parameter and API token as part of the request.Link to the
Ready Platform API
documentation: https://readyeducationpublicapi.docs.apiary.io/#reference
The
Ready Platform API
responds with the user information (which Ready receives through the integration with the institution authentication (LDAP/SSO)).User's information can be used by the institution to look up data in the database and return it in the
Campus Web App
to the app user.
Key Terms
Ready Mobile App
= Your branded campus app that students can download to their phone.
Campus web app
= A campus created and maintained web application that can be rendered through an in web browser within the Ready Mobile App.
Institution Servers
= A shorthand for backend webservices created and maintained by the institution.
Ready Servers
= A shorthand for backend webservices created and maintained by the Ready Development team.
Ready Platform API
= A webservice provided by Ready Education
for customers to use to access the user's username.
Ready JS-SDK
= A JS SDK that institutions can use to assess if the current user is logged in and their username if they are.
User token
= A string uniquely generated per user upon login, and refreshed through the Ready Mobile App
's session management.