Skip to main content

Architecture

The following figure provides an overview of the Qlik Sense Proxy Service (QPS) API architecture.

All browser to QPS and browser to External Authentication module communication uses standard SSL (HTTPS). All communication within the trusted zone is secured by client/server certificate authentication (mutual TLS).

APIs implemented by the Proxy

Personal API

The Personal API is used by the browser to query session information, to get the login or logout URI, and to log out the user. See Personal API.

Proxy (Ticket) API

The Proxy (Ticket) API is used by the External Authentication module for generating a ticket and injecting session attributes. See Ticket.

Proxy (Error logging) API

The Proxy (Error Logging) API is used by external modules to add error logging that is injected into the Proxy logs. See Error logging.

Proxy (Session) API

The Proxy (Session) API is used by external modules to get, add, and delete Proxy sessions. See Session.

Proxy (User) API

The Proxy (User) API is used by external modules to get and delete Proxy sessions for a specific user. See User.

APIs implemented by external modules

Session module API

The Session module API is implemented by the external session module. This API is used by the Proxy to get, add, and delete Proxy sessions by session or by user (a mirroring of the Proxy (Session) and the Proxy (User) APIs). See Session module API.

Load Balancing module API

The Load Balancing API is implemented by the external Load Balancing module. This APIĀ is used by the Proxy to get a prioritized list of engines for load balancing. See Load balancing module API.

See also: