Generating the API reference for the Qlik Sense Proxy Service

You can generate an API reference document from the OpenAPI Specification for the Qlik Sense Proxy Service. The OpenAPI Specification is an API definition file in JSON or YAML format that describes all of the public API endpoints for the Qlik Sense Proxy Service. It serves as a comprehensive API reference that includes:

  • A description of each endpoint.
  • The path of the endpoint including required and optional path and query parameters, if applicable.
  • An example of the request body for PUT and POST methods.
  • An example of a successful response.
  • The schema of the entity in the request body (if applicable) and in the response.
  • Possible response codes.

To generate the API reference document from the OpenAPI Specification for the Qlik Sense Proxy Service:

  1. Using a REST client such as Postman, make a GET request to one of the following endpoints to retrieve the API definition in JSON format:

    • Proxy APIs

      server.name.com:4243/qps/about/openapi/main

    • Personal API

      server.name.com:4243/qps/about/openapi/personal

  2. Copy the response of the request.
  3. Open the online version of the Swagger Editor.
  4. Paste the response of the request into the left pane of the Swagger Editor.

    The API definition is rendered as an API reference document in the right pane.

Did this information help you?

Thanks for letting us know. Is there anything you'd like to tell us about this topic?

Can you tell us why it did not help you and how we can improve it?