Analyze PDFMonkey Data in Infragistics Reveal
Reveal is a data visualization solution provided by Infragistics and can be paired with the CData API Server to build dynamic dashboards from live PDFMonkey data. The CData API Server generates an OData API for PDFMonkey, which is natively consumable in Reveal. In this article, we walk through connecting to PDFMonkey in API Server and connecting to the API Server from Infragistics Reveal to create a simple dashboard.
Connect to PDFMonkey from API Server
CData API Server uses a straightforward, point-and-click interface to connect to data sources and generate APIs.
- Open API Server and click Settings -> Connection -> Add Connection
- Select "PDFMonkey"
- Enter the necessary authentication properties to connect to PDFMonkey.
Using API Key Authentication
PdfMonkey uses API key authentication. To obtain an API key:
- Log in to your PdfMonkey account at https://app.pdfmonkey.io
- Navigate to your account settings
- Open the API Key page
- Copy your API key
After obtaining your API key, set the following connection properties:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your PdfMonkey API key.
Example Connection String
Profile=C:\profiles\PdfMonkey.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"
Connecting to PdfMonkey
Once the authentication is configured, you can connect to PdfMonkey and query data from any of the available tables such as CurrentUser, DocumentCards, Documents, DocumentTemplateCards, and DocumentTemplates.
Add PDFMonkey Resource Definitions in API Server
After connecting to PDFMonkey, create Resources, which represent API endpoints for PDFMonkey data.
- Click Settings -> Resources -> Add Resource
- Select the PDFMonkey connection
- Select the table you wish to retrieve and click Next
- (Optional) Edit the resource to select specific fields and more
- Save the settings
Add an API Server User
Create a User to connect to PDFMonkey from Reveal through API Server.
- Click Settings -> Users
- Click Add
- Configure a User with access to the PDFMonkey Connection and Resource(s)
(Optional) Configure Cross-Origin Resource Sharing (CORS)
When accessing and connecting to multiple different domains from an application such as Ajax, there is a possibility of violating the limitations of cross-site scripting. In that case, configure the CORS settings in Settings -> Server.
- Enable cross-origin resource sharing (CORS): ON
- Allow all domains without '*': ON
- Access-Control-Allow-Methods: GET, PUT, POST, OPTIONS
- Access-Control-Allow-Headers: Authorization
Save the changes to the settings.
Create a Dashboard in Reveal
With the API Server configured, we can visualize PDFMonkey data in Reveal.
- Log into Reveal and click Dashboards -> New
- Click Data Source -> OData Feed
- Specify the API Server API endpoint URL, for example: https://serverurl/api.rsc
- Select Generic Credentials and specify the API Server username and authentication token
- Select the entity you wish to visualize
- Select fields and choose a chart type
More Information & Free Trial
At this point, you have created a simple dashboard from live PDFMonkey data. For more information on creating OData feeds from PDFMonkey (and more than 150 other sources), visit the API Server page. Download a free, 30-day trial and start working live PDFMonkey data in tools that consume OData APIs.