ClassKit Catalog API

Overview

Access the ClassKit Catalog API from your computer or server to declare an app’s educational activities when you have an app that adopts the ClassKit framework. Traditionally your app declares its activities — represented as contexts — to the ClassKit framework at run time so that teachers can assign the activities using the Schoolwork app. As an alternative, the ClassKit Catalog API lets you declare contexts ahead of time to a central server so that:

• Teachers can browse your app’s activities in the Schoolwork app before running your app for the first time on their device.

• You can include keywords describing your activities that help teachers find your content.

• Your app can support a large number of assignable activities without the app having to declare all the content to the ClassKit framework at run time.

Content that you upload to the ClassKit Catalog API becomes publicly available to all teachers using the Schoolwork app. If you have dynamically-generated or user-specific content, continue to publish that only through the ClassKit framework.

Topics

Essentials

• Authenticating Calls to the ClassKit Catalog API
• Testing Your ClassKit Catalog Implementation

Declaring Contexts

• Preparing Context Data
• Create or Replace Contexts
• Get a Context
• Delete a Context
• Context
• ContextsRequest
• ContextsResponse

Uploading Thumbnails

• Create or Replace a Thumbnail
• Get a Thumbnail
• Delete a Thumbnail

Retrieving Status

• Get Status
• Status