The Mail & Deploy API is designed to expand the reach of your organization by making your Qlik® data available to users. External developers are able to build products/applications that are in some way reliant on the business. The API connects Qlik® data to action and there are no limits on how a company can then go on to use that data.
Hello and welcome to today’s #Feature Friday!
You have probably heard this a million times, but we will say it again. Data is useful information that you collect to support organizational decision-making and strategy.
It helps you to make informed decisions. You get the results you want. And you will find solutions to problems. As well as be strategic in your approaches and keep track of it all. And of course, make the most out of your money …
Data allows organizations to measure the effectiveness of a given strategy. They can visualize relationships between what is happening in different locations, departments, and systems. It increases efficiency. And it even will help you explain (both good and bad) decisions to your stakeholders.
Simply stated, data is knowledge. Data is the key.
You and your business probably already have most of the data and expertise you need available to begin analysis. The only problem is that your data is locked. It needs to be connected from all of your numerous data silos, such as databases, data lakes, data warehouses, CRM, ERP, HCM systems and so on.
This dilemma makes it difficult for management teams to optimize decision workflows. As they do not have the expertise of developers. Nor the time and money needed to fully unlock the potential of the data.
We want to help you to easily connect your Qlik® data with 3rd party vendors. So you can extend your Qlik® ecosystem to enable data-driven decision making with Mail & Deploy and the Mail & Deploy API.
The Mail & Deploy API is critical. It acts as an interface between all the features of Mail & Deploy and all data consumers within your company.
Here is an example: You are the developer of a CRM system (or any other 3rd party vendor). So you can easily develop interaction between the CRM system and Mail & Deploy. If, for instance, you have customer reports in Mail & Deploy that contain data from QlikView® and/or Qlik Sense® and you want to your CRM users to request these reports, you can use Mail & Deploy’s API to submit a request to create a report for a given Customer ID and the API will return the report document file to the caller.
The API allows you to connect with everything Mail & Deploy offers. Using the API, Mail & Deploy reports and thus QlikView® and Qlik Sense® can be strongly integrated into existing applications. It, therefore, opens a new world!
What can you do with the Mail & Deploy API?
With the API of Mail & Deploy, you can:
- Create Report Document Request
This request instructs Mail & Deploy to create a report document from a report with a given file type and – optionally – parameters.
- Execute Task Request
This request instructs Mail & Deploy to execute a task of the given repository.
- Get Available Reports Request
This request instructs Mail & Deploy to return all available reports of the given repository.
- Get Available Tasks Request
This request instructs Mail & Deploy to return all available tasks of the given repository.
Main points about Mail & Deploy API
The API of Mail & Deploy is provided through an HTTP REST web service with custom HTTP authentication. There is no need to learn yet another 3rd party library to use the API. You can use your favourite HTTP/REST library available for your programming language to make HTTP calls.
The web service supports both POST and GET requests. POST requests need to supply their parameters in the HTTP message, GET requests may supply their parameters through URL parameters. For every request, the API will return an XML document. That contains the requested data or, if unsuccessful, an error message.
To use Mail & Deploy API, you have to ensure the following conditions:
- Mail & Deploy API must be enabled in the Control Panel.
- At least one user with at least a role of API Consumer needs to be set up.
- If the API is called from another computer, a network connection between that computer and the computer that runs Mail & Deploy Server needs to be established. And the configured port on which the API web service runs must not be blocked by any firewall in between.