Introduction

Welcome to the Lessonspace Docs! Here you can get familiar with the Lessonspace API and get your hands dirty with some code. This documentation is aimed at developers with a technical background so an understanding of RESTful APIs, HTTP and basic programming concepts is recommended.

The Lessonspace API can be called using the Organisation's API Key or on a per User level, with User Tokens & the necessary IDs. The User level invocation is slightly more technical and can be found in our Postman collection.

The following documentation is intended to get you up and running using the Launch API with your Organisation's API Key. It covers the basic concepts involved, calling the API and using the results returned to integrate an online collaborative classroom into your website.

The Launch API is the higher-level component and represents the simplest way of getting started with the Lessonspace API. It provides a series of convenience endpoints that allow you to create Spaces with various configuration options. During implementation you need not worry about handling user sign up and/or login as the business logic is handled behind the scenes when users are invited to and join a Space.

The Launch API is largely centered around the Launch endpoint. The Launch endpoint returns a link to a Space that can be embedded into an iframe in your application. Moreover, various configuration options passed in JWTs can identify a user or restrict a session start time for example.

The how-to guides go over the most common use cases and features that you might want to implement. For a list of available endpoints, please consult the API reference.