Getting Started with the MyHomeworkSpace Public API

The MyHomeworkSpace public API provides a method of programmatically accessing a user’s account over the internet.

Requesting API Access

API Access is not yet automated. To get a Client ID, you can reach out to us by emailing [email protected], or using the feedback buttons in MyHomeworkSpace. In your request, make sure to include a valid origin (for CORS purposes), as well as a valid callback url.

If you need to make any changes to this information, feel free to reach out to us.

If you just want to try out the API, without building a specific application, you can use the “Try it out” sections of the API Reference, which handles all authentication for you.

Authentication flow

When an app is registered for the API, it is given a Client ID. This unique code identifies the application to MyHomeworkSpace. When the app wants to gain access to a user’s account, they send the user to the application/requestAuth/:clientid endpoint, where :clientid is replaced with your application’s Client ID. The user is then redirected to a sign in screen where they can approve your application’s access. If they approve your app, they are sent to your Callback URL (set at app registration) with a query string (url parameter) called token, with a specific token.

graph TD; Client[Your app] -- sends user to application/requestAuth/:clientId -->SignIn[User prompted to give account access] SignIn -- User Grants Permission -->Callback[Callback URL with token query string] SignIn -- User Rejects Permission -->MHS[MyHomeworkSpace home page]

Endpoints

All endpoints are listed in the API Reference. Click on any endpoint to view more details about it.

Was this article helpful?

Yes

No

Table of Contents
Page contributors
nywillb
Edit this page