This API is exclusively available to authorized LMS partners. It enables partners
to provision and manage schools directly from their LMS platform using API keys —
including browsing available subscription plans and registering new schools.
The public-key is issued by Jusoor Labs to each partner and
must be included in every API request as a required header.
Upon successful school registration, the returned credentials
(including token and referer) must be securely stored
and used for all subsequent interactions with the school's LMS API.
{Jusoor Labs
endpoint}/api/v1/partner/plans
Note:
The plans returned are filtered based on the partner's region or country.
Review the list carefully and select the most suitable plan.
Use the plan's id when registering a new school.
| Name | Required | Type | Description |
|---|---|---|---|
| accept | Required | string | application/json |
| public-key | Required | string | Your unique Partner API key, issued by Jusoor Labs |
No parameters required.
Returns the list of subscription plans available to the partner,
filtered by their region or country. Use the id field
of the desired plan when submitting a school registration request.
{
"status": true,
"message": "Plans fetched successfully",
"data": [
{
"id": 2,
"name": "Custom Plan 22",
"max_users": 5414,
"max_experiment_uses": 30000
},
{
"id": 4,
"name": "Plan 2025",
"max_users": 3000,
"max_experiment_uses": 3005
},
{
"id": 6,
"name": "Custom Plan",
"max_users": 5000,
"max_experiment_uses": 50000
}
]
}
{Jusoor Labs
endpoint}/api/v1/partner/register-school
Registers a new school, creates the admin user account, and optionally
configures an LTI integration in a single request.
Note: Due to school provisioning, this request may
take between 30 to 60 seconds to complete.
Please account for this in your integration's timeout settings.
| Name | Required | Type | Description |
|---|---|---|---|
| accept | Required | string | application/json |
| public-key | Required | string | Your unique Partner API key, issued by Jusoor Labs |
| Name | Required | Type | Description |
|---|---|---|---|
| plan_id | Required | integer | The ID of the chosen subscription plan (retrieved from Get Plans) |
| admin | Required | object |
Admin user details: name, username, email, password
|
| school | Required | object |
School info: sub_domain, school_name, school_name_ar (optional)
|
| lti | Optional | object |
Applicable only for the Classera custom partner integration.
When this object is provided, all of its fields become required:
issuer, client_id, deployment_id, platform_name,
platform_url, school_id, school_name_en,
school_name_ar
|
The following example includes the optional lti object,
which is only applicable for the Classera custom partner integration.
Omit this object if LTI is not required.
{
"plan_id": 2,
"admin": {
"name": "admin",
"username": "admin",
"email": "hamza.alzughbieh@jusoorlabs.com",
"password": "Admin@Pass1"
},
"school": {
"sub_domain": "school",
"school_name": "school Name",
"school_name_ar": "Arabic Name"
},
"lti": {
"issuer": "https://partners.com",
"client_id": "partner_jusoorlabs_2025",
"deployment_id": "deploy_ELT00000",
"platform_name": "Partner",
"platform_url": "https://partner.com",
"school_id": "50102",
"school_name_en": "English Name",
"school_name_ar": "Arabic Name"
}
}
On success, the school is provisioned and the admin user is created.
The response includes all API credentials required to interact with
the school's LMS — store them securely. If an lti object
was provided in the request, the same data is returned in the response
for use in your platform's LTI configuration.
{
"message": "School created successfully and is ready to use. Please use the following credentials to interact with the LMS API. LTI protocol is enabled — use the LTI data below to configure your platform.",
"token": "z2Wr03XIgSHTNaGmQyoetQKjnxAh1vdJuWrvU1uz",
"referer": "school-lti",
"license": "SCHOOL-LTI-422A324D-0F87-4803-B118-D33EDAD3D292",
"secret": "SCHOOL-LTI-F4E22ED4-7048-463F-8B94-F1F641148237",
"school_api_endpoint": "https://school-lti.jusoorlabs.com/api/v1/",
"jusoorlabs_endpoint": "http://jusoorlabs.com/api/v1/",
"lti": {
"issuer": "https://partners.com",
"client_id": "partner_jusoorlabs_2025",
"deployment_id": "deploy_ELT00000",
"platform_name": "Partner",
"platform_url": "https://partner.com",
"school_id": "50102",
"school_name_en": "English Name",
"school_name_ar": "Arabic Name"
}
}