Skip to main content
Version: 1.0.1

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. The Introduction section provides an overview of the API's core concepts. The Authentication section explains how to authenticate your application with our API.

Other sections cover specific types of resources (like lessons, tracks, or users) that the API can work with. Each resource has its own section that explains how to create, read, update, and delete instances of that resource.

Getting Started​

To get started, you'll need an API key. Our API uses API keys to authenticate requests. You can view and manage your API keys in your account settings. For more information, see the Authentication page.

Please remember to keep your API keys secure. Do not share your secret API keys 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.

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!