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.
- Health and Wellness Endpoint
- Form Endpoint
- QR Code Endpoint
- Case Endpoint
- Exposure Notification Endpoint
Health and Wellness Endpoint
When you create an API key for Health & Wellness Insights, anyone who has that token can access the following endpoints:
- Daily Case Stats
- Form Completion Stats
As you are creating your API key, make sure to enable to Health & Wellness endpoint (Found in API Management under Insights).
The Form endpoint returns an array of Forms and metadata about them. Make sure to enable to Form endpoint.
QR Code Endpoint
You can programmatically view, create and modify QR Codes used in the Contact Trace module of Campus Cloud. The QR Code endpoint returns a list of QR codes and lets you modify and delete existing codes. You can also create new QR codes with this endpoint.
Make sure to enable to QR Code endpoint.
You can get a list of cases currently active in the Contract Trace module of Campus Cloud. The Case endpoint returns an array of Cases and metadata about them. Make sure to enable to Case endpoint.
Exposure Notification Endpoint
You can programmatically get details of notifications sent to students as part of the Contact Trace module in Campus Cloud. The Exposure Notification endpoint returns an array of sent notifications with information about who they were sent to. Make sure to enable to Exposure Notification endpoint.