API Changes in QSDA Pro 1.7

QSDA
1

QSDA Pro release 1.7.0 has brought some changes to using the optional REST API. (This has no impact on the QSDA browser UI).

Use UI Port for API Calls
Beginning with release 1.7, you should access the API using the UI port (default 5003) like:
http://localhost:5003/api/v1/collectors/ping

Use the same port for the API documentation
http://localhost:5003/swagger/index.html

If you enable the new “Enable HTTPS” option in the configuration, you must use the UI port for API access. The API Port will not work with HTTPS.

Access to the API using the API Port (default 5000) is deprecated and will be removed in a future release.

New API Auth Option
New feature, “Use API Auth” is available in the QSDA Configuration. If enabled, your API calls must include the bearer authorization token generated in the same configuration dialog. You can include the bearer token even before enabling “Use API Auth”.

If you are actively using the API, it is recommended that you begin modifying your code to include the bearer token. The use of API Auth will become mandatory in a future release.

For a complete list of changes in 1.7, see What's New in V1.7.0

2

Hi Rob,

Do you have an example somewhere of the REST API header values we need to use?
I have tried a few options, but I still struggle to get this to work.

Like Header “bearer” = “User Key: ey…”

Qlik sense returns the following error message:
“HTTP protocol error 401 (Unauthorized): ‘Bearer’ authentication schema provided by the web-service is not supported or your credentials are not valid.”

Once I manage to authenticate with the generated User Key, the rest should be straightforward.

Thanks.
Armand

3 
Authorization: Bearer xyzz....

Here’s a video that shows how you can use the Swagger page to test the token and discover the Header.

-Rob

1 Like