Page Comparison

Welcome to the Cloud Card API Documentation.

Usage

1. For most uses, you will need to first authenticate with the API to get an authentication token.  

2. For all subsequent requests, store the authentication token in an HTTP header called X-Auth-Token.

Common Use Cases

Automatically Creating Users

• Generate a list of email addresses (and possibly student ID numbers) for the users that need to be imported into Cloud Card.
• Iterate over the list, calling Create a Person for each desired user.
• Here is a Postman collection that demonstrates the workflow for creating users. 
  

  View file
  name CloudCard User Import Requests.postman_collection.json height 250

Automatically Download Photos

• Call Get Photo List specifying "status=APPROVED" to get a list of approved photos, which are ready to be downloaded.
• Iterate over the list of approved photos 
  • call Get the Binary Photo Data for each approved photo
  • save the binary image to a file or to a BLOB in a DB
  • Update the Photo setting the status to "DOWNLOADED"

• Here is a Postman collection that demonstrates the workflow for downloading photos. 
  

  View file
  name CloudCard Photo Download Requests.postman_collection.json height 250

Integration Fee

• There is a $3,300 integration fee for all technology partners. 

• This fee is waived for customer organizations. 

Common Use Cases

Automatically Creating Users

• See our Integration Guidelines for Importing Users into CloudCard

Automatically Download Photos

• See our Integration Guidelines for Downloading Photos from CloudCard