topic Re: Need Example for OEM Workflow (REST API Data Connection creation) in Integration, Extension & APIs

Need Example for OEM Workflow (REST API Data Connection creation)

yosuke-coupa — Thu, 20 Apr 2023 17:27:35 GMT

Hello,

I am working on understanding the REST APIs to integrate Qlik into our own custom workflow. I have questions regarding the scenario below:

Assumption

QVF file with no data, references a space-agnostic Data Connection called 'my-data-connection' is available
A bot user authenticated with regional OAuth is making all API calls as a "backend service" i.e. they are operating as a tenant admin.

Steps

Create a Shared Space (POST /api/v1/spaces)
Import App with no data into Space (POST /api/v1/apps/import)
Create Data Connection with name "my-data-connection" (POST /api/v1/data-connection)
Reload data (POST /api/v1/reload)
Add users and permissions, etc.

Question

In step 3, the documentation around the parameters required to create a Data Connection is not very detailed. We are working with MS SQL Server, and it isn't clear what the qConnectStatement should be.

Connection strings contain the user name and password, and it is unclear how to encrypt them with the API.
Creating the Data Connection through the UI and observing the network traffic is not a good reference as it does not use the same calls as the publicly available REST API.
After trying several variations on the qConnectStatement, ultimately they all fail the data load with an error stating that the "Connector 'my-data-connection' not found". In the UI, it manifests as an UI modal alert stating "Error connecting to the Sense service".

Re: Need Example for OEM Workflow (REST API Data Connection creation)

Dave_Channon — Mon, 24 Apr 2023 09:32:12 GMT

Hi @yosuke-coupa

Currently our public APIs don't handle credentials, this is handled by the dcaas API (which is what you see in the console). You need to use both to create a connection today. As part of improving the usability of these APIs, we are building a new API to handle both data connection creation and credential management. This will remove the need to create the mysterious qConnectionStatement, and you'll pass just the attributes that you see in the wizard to the API.

Please ping your account team and ask them to connect with me, I can show you what we're working on and the timelines we're working to - MSSQL is currently planned in the first slice.

Re: Need Example for OEM Workflow (REST API Data Connection creation)

paulcalvet — Tue, 13 Jun 2023 11:26:33 GMT

Hello @Dave_Channon ,

We have the same problem to create Athena connection with API.

Do you know when it will be available ?

Thanks.

Re: Need Example for OEM Workflow (REST API Data Connection creation)

Dave_Channon — Tue, 13 Jun 2023 12:08:50 GMT

Hi @paulcalvet

The first phase is currently in testing and we're working towards release. Athena should be in the second phase, currently planned for later this year. If you'd like to talk about what we're building, please feel free to reach out!

Re: Need Example for OEM Workflow (REST API Data Connection creation)

paulcalvet — Tue, 13 Jun 2023 15:06:20 GMT

Thank you Dave, I will see ho it works with the first connector and wait for Athena/

Regards