Getting Started

Welcome to Our API Documentation

Welcome to our API documentation. Here, you'll find comprehensive guides and documentation to help you start working with our API as quickly as possible.

Our API allows you to integrate your application with our platform and perform various operations. We strive to have a fully RESTful API with clear, concise JSON responses.

About This Documentation

This documentation is divided into several sections. Getting Started gives an overview of the API's core concepts. The Authentication section explains how to authenticate your application with our API.

The API reference covers each type of resource the API works with (like lessons, tracks, or users), with every available endpoint, its parameters and its responses.

Getting Started

To get started, generate a secret key in the back office. Copy it right away: it is only shown once. You then exchange this secret key for a short-lived JWT access token, and send that token in the Authorization: Bearer header of every request. The Authentication guide walks you through each step.

Please remember to keep your secret key and tokens secure. Do not share them in publicly accessible areas such as GitHub, client-side code, etc.

Making Requests

All API requests should be made over HTTPS. You must authenticate for all requests.

Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients.

OpenAPI Specification

You can download the complete OpenAPI specification for this API to use with your favorite API client tools like Postman, Insomnia, or code generators.

📄 Download OpenAPI Specification

The OpenAPI specification includes:

• Complete endpoint documentation
• Request/response schemas
• Authentication requirements
• Example requests and responses

This file can be imported into API development tools for testing and integration purposes.

Versioning

Our API is versioned to allow for continuous improvement while providing stability for applications relying on it. When changes are made, we will release new versions. Older versions will be maintained for a period of time to allow for migration to the newer version.

Support

We hope this documentation provides all the information you need to work with our API. However, if you run into problems or have a question, feel free to reach out to our support team.

We're excited to see what you will build!