Manage PDFMonkey Data in DBArtisan as a JDBC Source

The CData JDBC Driver for PDFMonkey seamlessly integrates PDFMonkey data into database management tools like DBArtisan by enabling you to access PDFMonkey data as a database. This article shows how to create a JDBC source for PDFMonkey in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate PDFMonkey Data into DBArtisan Projects

Follow the steps below to register PDFMonkey data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the PDFMonkey JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.api.jar
   

   Fill in the connection properties and copy the connection string to the clipboard.

   

   Below is a typical connection string:

   jdbc:api:Profile=C:\profiles\PdfMonkey.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"

6. Finish the wizard to connect to PDFMonkey data. PDFMonkey entities are displayed in the Datasource Explorer.

You can now work with PDFMonkey data as you work with any other database. See the driver help documentation for more information on the queries supported by the PDFMonkey API.