How to Query PDFMonkey Data in MySQL Workbench

You can use the SQL Gateway from the ODBC Driver for PDFMonkey to query PDFMonkey data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live PDFMonkey data in MySQL Workbench.

Connect to PDFMonkey Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

Using API Key Authentication

PdfMonkey uses API key authentication. To obtain an API key:

1. Log in to your PdfMonkey account at https://app.pdfmonkey.io
2. Navigate to your account settings
3. Open the API Key page
4. Copy your API key

After obtaining your API key, set the following connection properties:

• AuthScheme: Set this to APIKey.

Set the following in the ProfileSettings connection property:

• 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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to PDFMonkey data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

👁 Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Query PDFMonkey from MySQL Workbench

The steps below outline connecting to the virtual PDFMonkey database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live PDFMonkey data.

Connect to PDFMonkey through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for PDFMonkey).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.

👁 Image

Query PDFMonkey Data

1. Open the connection you just created (CData SQL Gateway for PDFMonkey).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve PDFMonkey data, like SELECT * FROM `CData API Sys`.CurrentUser;

👁 Image

With access to live PDFMonkey data from MySQL Workbench, you can easily work with PDFMonkey, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData API Driver for ODBC and the CData SQL Gateway.