Overview

View as Markdown

This is the version 1.0 of the public DreamClass API.

It includes REST operations for managing numerous items in your DreamClass platform, such as Admissions, Invoices, Students, and Events. There’s also a collection of webhooks available to allow you to listen for changes within the platform as well.

Important Notices

For security reasons, you must contact support@dreamclass.io to request API activation for your account. This will then allow you to access and manage your DreamClass API key and school code.

How to send an authorized request

To make an authorized request, you will need three pieces of information:

  • your API key

  • your school code

  • your tenant code

Once DreamClass tech team enables your API access you can access your API key and school code in your DreamClass settings:

Your tenant code will be your DreamClass account subdomain, so if you access your DreamClass via https://myaccount.dreamclass.io then your tenant code is “myaccount”. However if you have a whitelabeled domain set up then your tenant code will be your full domain that you DreamClass account is whitelabeled to, so if you setup your domain to be https://portal.mywebsite.com then your tenant code is “portal.mywebsite.com”.

All API requests are sent to the same endpoint, so when reading these docs {{server}} should always be https://api.dreamclass.io.

When making the request, be sure to use API Key as the Auth Type, and configure it like so:

key | dreamclass-secret-key
value | {{yourApiKey}}
location | Header

In the Headers of your request, you will also need to include the following items:

schoolCode | {{schoolCode}}
tenant | {{tenant}}