Ready API Endpoints

Owned by jamal.naveed
Last updated: Sept 03, 2024 by Adi A
3 min read

As a Campus Cloud administrator, you can use the API to grant access to data on Campus Cloud. For more information on these endpoints, please see Ready API Technical Documentation.

To create an API key, follow the steps in this article: Create a New App Integration. 

  1. Audience Endpoint

  2. Campus Endpoint

  3. Experience endpoint

  4. Push Notification Endpoint

  5. User Information Endpoint

Audience Endpoint

As a Campus Cloud administrator, you can get a list of the campus app audiences (lists of app users). The Audience endpoint returns a list of app audiences and their IDs. 

You can use an experience ID number with the push notification endpoint to send a message to all users within an app experience. 

Make sure to enable the Audience endpoint.

Once you have generated an API key, your school can send messages to all users within an experience as follows:

  • Use the Audience endpoint to determine the ID of the target campus

  • Use the push notification endpoint to send your message to that audience ID. 

Your notification appears in the notification centre of users signed in to the target experience. 

Campus Endpoint

The Campus endpoint gives access to this information and returns a list of campus names and their IDs. 

You can use a campus ID number with the push notification endpoint to send a message to all users within a campus. 

Make sure to enable the Campus endpoint.

Once you have generated an API key, your school can send messages to all users within the campus as follows:

  • Use the Campus endpoint to determine the ID of the target campus

  • Use the push notification endpoint to send your message to that campus ID. 

Your notification appears in the notification centre of users signed in to the target campus. 

Experience Endpoint

The Experience endpoint returns a list of app experiences and their IDs. 

You can use an experience ID number with the push notification endpoint to send a message to all users within an app experience.

Make sure to enable the Experience endpoint.

Once you have generated an API key, your school can send messages to all users within an experience as follows:

  • Use the Experience endpoint to determine the ID of the target campus

  • Use the push notification endpoint to send your message to that experience ID. 

Your notification appears in the notification centre of users signed in to the target experience. 

Push Notification Endpoint

As a Campus Cloud administrator, you can create a new app integration that uses the push notification endpoint. With third-party software (such as POSTMAN), you can use this endpoint to create push notification announcements for app users. With other software, you can schedule announcements ahead of time and manage the schedule. 

With the push notification endpoint, you can send announcements campus-wide (i.e., to all logged-in users and visitors).

To send a Push Notification:

  • Log in to Campus Cloud

  • Click your name in the top-right

  • Click "API Management" You will need an API key to use with the third-party software. Follow the steps in this FAQ:  Create a New App Integration.

  • Enable to push notification endpoint.

  • Select the Experience and/or Audience for each Push Notification. The Campus will automatically be checkmarked for the current Campus you are on. 

When you generate an API key, you can use the key on POSTMAN to customize the push notification details.

The push notification message in POSTMAN has the following fields:

  • subject

  • message

  • email

  • notify_at_epoch

  • created_on_epoch

  • is_app_wide

Once the message has been drafted, it can be pushed out to users.

Announcements which are to be sent to students within an hour are locked and cannot be modified or deleted.

User Information Endpoint

As a Campus Cloud administrator, you can create an app integration with the user information endpoint. The User Information endpoint gives access to student information such as name, email address, and student ID. This information becomes available to third-party apps that you can launch from within the campus app.

With the user information endpoint, you can develop apps and plug-ins that deliver customized information to students and then embed those apps into the campus guide.

Make sure to enable the User Information endpoint.

Once you have generated an API key, your school can embed personalized information into the campus guide as follows:

  • Create a web app that uses authenticated login and personalizes student information

  • Integrate the Ready API key in the web app.

  • Create an Authenticated Web App Tile in the campus guide, linked to your app.

When students access that web app tile on their campus app, it will display their particular, personalized information.

With the User Information endpoint, you can connect systems that have plenty of information but no channel for providing access to that information. Students already have the campus app in hand. By connecting web apps and using the Ready API, you can display user-specific information in the campus guide.

Â