Brusnika.LMS Public API — LMS Integration with HR, CRM and BI
Maria Ivanova
Analyst
Integrations mentioned in this article
The Brusnika.LMS Public API is a programming interface for connecting the LMS with external systems such as HR systems, CRMs, websites and BI platforms. It can be used to manage users and learning content, create assignments, retrieve learning results and send event notifications to external systems.
The Public API is currently in beta. Its settings are available to portal administrators under System Management → Public API.
The API is primarily intended for developers building integrations for customers and partners. A portal administrator creates access keys and controls which API sections each key can access.
What the Brusnika.LMS Public API can do
The API can be used to:
- retrieve users and search for users;
- create external users and login-based accounts;
- update external users;
- work with departments and custom profile fields;
- create, update, retrieve and delete lessons, courses, programs and tests;
- create and manage content and program assignments;
- manage subaccounts;
- upload, retrieve and delete files;
- work with knowledge base folders and materials;
- manage subscriptions to knowledge base materials;
- retrieve learning reports;
- retrieve test results, 360 assessment results, issued certificates and survey responses;
- subscribe to outgoing webhooks;
- receive notifications about changes in the LMS;
- check service availability.
The API therefore supports both reading data from the LMS and performing supported write operations in the LMS.
API access keys
Access to the Public API is controlled through API keys.
When creating a key, the administrator can specify:
- key name;
- permissions by API section;
- separate read and write permissions;
- expiration period.
Available expiration periods are:
- unlimited;
- 30 days;
- 90 days;
- 365 days.
The key value is shown only once when the key is created.
The administrator can see the list of keys and their statuses:
- active;
- expired;
- revoked.
A key can also be revoked.
Each key works only with the portal where it was created. A key issued for one portal cannot be used as an API key for another portal.
API documentation is available at the address of the portal itself.
API permissions
Permissions are configured separately for API sections. Read and write access can be controlled independently.
For example, an integration can receive a key that can read reports without being allowed to modify LMS data.
The exact operations available to an integration depend on the API section and the permissions assigned to its key.
API resources
Lessons
The Lessons API supports:
- listing;
- viewing;
- creating;
- updating;
- deleting lessons.
Courses
The Courses API supports:
- listing;
- viewing;
- creating;
- updating;
- deleting courses.
Programs
Programs can be:
- listed;
- viewed;
- created;
- updated;
- deleted.
Tests
The API supports:
- listing tests;
- viewing tests;
- creating;
- updating;
- deleting tests.
Assignments
Assignments for content and programs can be:
- listed;
- viewed;
- created;
- updated;
- deleted.
Users
The Users API supports:
- listing and searching;
- viewing;
- creating a user profile;
- creating a login-based account;
- generating an invitation link;
- updating data;
- changing departments.
These are external users of Brusnika.LMS.
The Public API does not create actual Bitrix24 users or CRM seats. It creates external users and LMS accounts within the relevant LMS portal.
API updates are supported only for users that were created as external users.
A user cannot be deleted through the API. The user can be deactivated, while their learning history is retained.
When creating users, the available subscription seat limit may apply.
Subaccounts
The API supports:
- listing;
- viewing;
- creating;
- updating;
- deleting subaccounts.
Departments
The API can retrieve a list of departments.
Custom profile fields
The API supports:
- listing;
- viewing;
- creating;
- updating;
- deleting custom profile fields.
Reference data
The API provides access to reference data such as:
- certificate templates;
- categories.
Files
File operations include:
- listing;
- uploading;
- retrieving;
- deleting.
Knowledge base API
The Public API also supports the Brusnika.LMS knowledge base.
Knowledge base folders
The API provides access to:
- folder lists;
- the folder tree;
- folder details;
- materials contained in a folder;
- information about where a folder is used;
- folder creation;
- folder updates;
- folder deletion.
Knowledge base materials
Supported operations include:
- listing;
- viewing;
- retrieving view statistics;
- checking where a material is used;
- creating;
- updating;
- moving;
- deleting materials.
Knowledge base subscriptions
The API supports:
- listing subscriptions;
- viewing subscriptions;
- subscribing users;
- unsubscribing users.
This makes it possible for an external integration to work with the supported parts of the knowledge base structure, materials and subscriptions.
Reports through the API
The Public API provides five report groups:
- learning progress;
- test results;
- 360 assessment results;
- issued certificates;
- survey responses.
Reports support filtering by:
- employee;
- object;
- status;
- dates;
- “changed since”.
Large result sets are returned with pagination.
Pagination is useful when an external system regularly retrieves large amounts of learning data, for example for BI processing.
For anonymous surveys, reports do not contain respondent identity data.
Outgoing webhooks
Outgoing webhooks allow Brusnika.LMS to send an event notification to an external system when a supported event occurs.
The supported events include:
- a learning completion status changes;
- a certificate is issued;
- a test result is recorded;
- a survey response is received;
- a 360 assessment status changes.
Webhook management supports:
- event subscriptions;
- test delivery;
- secret rotation.
Notifications can only be sent to secured public endpoints.
If delivery fails, the system retries the delivery.
Webhook events are not necessarily delivered immediately after a change. Webhooks are enabled on the installation server, and events are detected according to the configured change-polling interval. If several status changes occur within the same interval, they can be delivered as a single notification.
Health check
The API includes a service health check that returns the current service status.
An external system can use this endpoint to monitor the availability of the integration interface.
HR-driven employee onboarding
One practical API scenario is automated onboarding from an HR system.
For example:
- The HR system records a new hire.
- The external system creates the user in Brusnika.LMS through the API.
- The employee is assigned an onboarding program through the API.
- Brusnika.LMS sends a webhook when a certificate is issued.
- The HR system can use this event to record the relevant completion status.
This scenario relies only on supported API capabilities: external user creation, program assignment and outgoing event notifications.
Exporting learning data to BI
Another scenario is regular transfer of learning data to a BI system.
For example:
- The administrator creates a key with reports: read permission.
- The key is configured to expire after 365 days.
- The BI system periodically calls the API.
- Learning progress and test results are retrieved page by page.
- The external BI system processes the returned data.
The API does not itself create BI dashboards or analytics. It provides supported LMS data to the external system.
How the API relates to other Brusnika.LMS features
The Public API works with several areas of Brusnika.LMS, including:
- users;
- subaccounts;
- departments;
- lessons;
- courses;
- programs;
- tests;
- assignments;
- knowledge base;
- certificates;
- surveys;
- 360 assessments;
- reports.
This makes the API an integration layer between Brusnika.LMS and external systems when a required operation is supported by the relevant API section.
Using Brusnika.LMS with business systems
Brusnika.LMS can be used together with business systems where employees already work. The Public API can connect the LMS with external HR systems, CRMs, websites and BI platforms.
However, an integration with a particular business system does not automatically mean that every API resource is available inside that system. The availability of a specific scenario depends on the relevant integration and its implementation.
The Public API should also be distinguished from other integration mechanisms.
Related integration mechanisms
“Keys”
Brusnika.LMS also has System Management → Keys, which contains portal identifiers used for integration or support.
These portal keys should not automatically be treated as the same thing as the Public API access keys issued under System Management → Public API.
Bitrix24 incoming webhooks
Bitrix24 incoming webhooks can be used to connect a separate LMS to Bitrix24 without installing an application from the Bitrix24 Marketplace.
This is a separate integration mechanism rather than another section of the Brusnika.LMS Public API.
Albato and Apify
In the relevant editions, Brusnika.LMS provides Albato and Apify connectors. These are related integration mechanisms and are not part of the boxed Public API itself.
Limitations and conditions
When designing an integration, consider the following rules.
The Public API is currently in beta.
API keys are portal-specific. A key created for one portal cannot be used with another portal.
The API works with external LMS users. It does not create actual Bitrix24 users or CRM seats.
Users cannot be deleted through the API. They can be deactivated, preserving their learning history.
API updates are supported only for externally created users.
User creation may be subject to the portal's subscription seat limit.
Anonymous survey reports do not contain respondent identity data.
Webhook delivery depends on the server-side change polling mechanism. Events can therefore be delayed, and multiple status changes within one polling interval can be delivered as a single notification.
Invitation links are not available in the standalone LMS. In that deployment, users sign in with a username and password.
API settings
The main settings are located in:
- System Management → Public API — create and manage Public API access keys;
- System Management → Keys — portal identifiers used for integrations or support.
API documentation is available at the address of the relevant portal.
Frequently asked questions
What is the Brusnika.LMS Public API?
It is a programming interface for connecting Brusnika.LMS with external HR systems, CRMs, websites and BI platforms and for performing supported operations with LMS data and objects.
Who can create API keys?
A portal administrator creates API keys under System Management → Public API.
Can API key permissions be restricted?
Yes. Read and write permissions can be configured separately for different API sections.
Can users be created through the API?
Yes. The API can create external users and login-based accounts. It does not create actual Bitrix24 users or CRM seats.
Can a user be deleted through the API?
No. A user can be deactivated, while their learning history remains available.
Can learning results be retrieved through the API?
Yes. The API provides reports for learning progress, test results, 360 assessments, issued certificates and survey responses.
Can learning data be exported to BI?
Yes. Supported reports can be retrieved through the API, including paginated result sets for larger data volumes.
Can an external system receive LMS event notifications?
Yes. Outgoing webhooks support learning status changes, certificate issuance, test results, survey responses and 360 assessment status changes.
Can the Public API be used with Bitrix24?
Brusnika.LMS supports integration with business systems including Bitrix24, but the availability of a specific API capability depends on the relevant integration. The Public API itself does not create Bitrix24 users or CRM seats.
Can the API be used with the knowledge base?
Yes. Supported API operations cover knowledge base folders, materials and subscriptions.
How long can an API key remain valid?
A key can be unlimited or expire after 30, 90 or 365 days.
Is the API key shown again after creation?
The key value is shown once when it is created. The administrator can later see the key's status in the key list, but the secret value is not shown again.
Short version
The Brusnika.LMS Public API is a beta integration interface for connecting the LMS with HR systems, CRMs, websites and BI platforms. It supports supported operations with users, learning content, assignments and the knowledge base, as well as access to learning reports. Outgoing webhooks can notify external systems about learning status changes, certificates, test results, survey responses and 360 assessment changes.