This article explains how to access the Learnybox API, navigate its documentation, and understand how authentication and API keys control access to your account’s resources.
You’ll also learn about the PHP client library available to simplify development and API calls.
An API (Application Programming Interface) allows two software components to communicate with one another using a defined set of protocols. Whether public or private, APIs are used to integrate functionalities, retrieve data, or extend an application’s capabilities.
You don’t need to know how the underlying program works — just how to interact with its API. APIs often come with detailed documentation to help developers save time and implement integrations efficiently.
For example, Learnybox uses external APIs, such as Stripe and PayPal, to process and retrieve data on transactions and users. Similarly, Learnybox offers its own API to developers who wish to interact with the platform programmatically.
Accessing the Learnybox API
You can access the Learnybox API directly from your account dashboard:
Go to Tools & Teaching → API
1. Library
Our API library includes detailed documentation for all available features and endpoints, including the data to send in requests and the data returned in responses.
Use the left-hand navigation menu to browse through the available API methods for different applications and tools.
A search bar is also available for faster access.
The middle section displays a summary of the API response, including the response format, status code, and a preview of the response body.
The right section shows a detailed, expandable JSON response sample.
2. Authentication and Security
Access to the Learnybox API is secured using:
Your Learnybox subdomain
An API key linked to your account
Your API key authorizes access to your account’s resources. In the API keys tab, you’ll find two types of keys:
Primary API key: Grants access to all features of the Learnybox API. You can regenerate it using the Regenerate button.
Restricted API keys: Grant access only to specific features. You can create as many restricted API keys as you need by clicking Create restricted API key.
Restricted keys are useful when you want to limit access for a particular application or developer. For example, you can create a key that grants a developer access only to course data.
All API calls are logged for monitoring and traceability.
How to Test the API
When you access the Learnybox API page, you’ll be directed to the API Introduction section. From there, you can explore and test API endpoints.
To make development easier, Learnybox provides a PHP client library that simplifies API calls.
You can find the Learnybox PHP client on Packagist:
Learnybox PHP Client on Packagist