Connect to PDFMonkey Data in DBArtisan

The CData ODBC 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 an data source for PDFMonkey in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.

Integrate PDFMonkey Data into DBArtisan Projects

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

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

You can then 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 ODBC.
3. Enter a name for the data source and select the DSN.
4. 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.