Unlock a world of possibilities! Login now and discover the exclusive benefits awaiting you.
The recent release of Data Product embeds the ability to let external systems and business partner to consume Data-Set trough an oData API.
References
- oData (in Wikipedia)
- Consuming data products through APIs
- How OData APIs Ensures Your Trusted Data Products are Consumable Everywhere
To enable the possibility to consume oData you need to create a Data Product - Working with data products.
This gives you immediately the ability to share the data included on DATA Product through an oData API endpoint
The menu open a page that provides you the API end point for each Data Set o the Data Product
and down the window you can fide the details on using the API, pagination , query parameters ….
each Data Set has his own API endpoint so is possible to use a single space for sharing to multiple parties, depending on the enforcement of your security policies.
Authentication and Authorization
The authentication is based to an API-Key that you need to provide during the rest call in the header with the common couple
authorization : Bearer eyxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The better, modern, and secure way to provide this Authorization Key is by using a Qlik Cloud oAuth2 configuration. References are on the help Creating and managing OAuth clients
Create an oAuth configuration with the minimum permissions required
Select
Client Type “Web”
Give a name, better if clearly refer to the external system or business partner to easily manage, disable, delete the configuration and then select as authorization "Scopes" “user_default” that provides Full access to your account and content
and then add also “dataproduct:consume” thar provide the ability to Read and consume data products.
Select “Allow Machine-to-Machine (M2M)”
Saving the configuration, it will provide oAuth Client and Client Secret that must be saved and keep in a safe place
and last, we need to set the Consent method as trust
User permission:
The first API call run using the oAuth2 credential (equal to a first user access ) will create and user with the name of the of the oauth2 configuration
You need to assign to the user the role you have created to consume Data Products, or having this role assigned it to all users.
You need to assign “Can Consume Data” permission on both Spaces the one where resides the Data-Set included on the Data Product and the one where you have Activated the Data Product.
Finally you can provide the correct endpoints and oAut2 credentials to your business partner. to access the data.
