qsAPI is a Python client library designed for interacting with Qlik Sense's QPS (Qlik Proxy Service) and QRS (Qlik Repository Service) interfaces. It simplifies common administrative and data operations within a Qlik Sense environment, providing a programmatic way to manage apps, users, security rules, and more. The current version is 2.2.0, and the library receives updates periodically, with major refactorings in its 2.1.0 release.
pip install qsapiVerified import paths — ran on the pinned version, not inferred.
This quickstart demonstrates how to initialize the `QlikSenseAPI` client using certificate-based authentication and fetch the Qlik Sense engine version. It highlights common configuration parameters for connecting to a Qlik Sense Enterprise server.
Update your import statements from `from qsapi import QlikSenseAPI` to `from qsapi.qsapi import QlikSenseAPI`.
Verify that `certificate` and `key` parameters point to existing, readable `.pem` files. Ensure the user specified by `user_directory` and `user_id` in the API call is authorized within Qlik Sense for the actions attempted.
Double-check that `user_directory` matches the user directory configured in Qlik Sense (e.g., 'DOMAINS', 'LDAP', 'LOCAL'), and `user_id` is the exact user ID within that directory that the certificate is intended for.