Natively Connect to PDFMonkey Data in PHP

Drop the CData ODBC Driver for PDFMonkey into your LAMP or WAMP stack to build PDFMonkey-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to PDFMonkey data, execute queries, and output the results.

Configure a DSN

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.

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.

Establish a Connection

Open the connection to PDFMonkey by calling the or methods. To close connections, use or .

$conn = odbc_connect("CData ODBC API Source","user","password");

Connections opened with are closed when the script ends. Connections opened with the method are still open after the script ends. This enables other scripts to share that connection when they connect with the same credentials. By sharing connections among your scripts, you can save system resources, and queries execute faster.

$conn = odbc_pconnect("CData ODBC API Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the function.

$query = odbc_prepare($conn, "SELECT * FROM CurrentUser WHERE = ?");

Execute Queries

Execute prepared statements with .

$conn = odbc_connect("CData ODBC API Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM CurrentUser WHERE = ?");
$success = odbc_execute($query, array(''));
 

Execute nonparameterized queries with .

$conn = odbc_connect("CData ODBC API Source","user","password");
$query = odbc_exec($conn, "SELECT , FROM CurrentUser WHERE = ''");
 

Process Results

Access a row in the result set as an array with the function.

$conn = odbc_connect("CData ODBC PDFMonkey data Source","user","password");
$query = odbc_exec($conn, "SELECT , FROM CurrentUser WHERE = ''");
while($row = odbc_fetch_array($query)){
 echo $row[""] . "\n";
}

Display the result set in an HTML table with the function.

$conn = odbc_connect("CData ODBC PDFMonkey data Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM CurrentUser WHERE = ?");
$success = odbc_execute($query, array(''));
if($success)
 odbc_result_all($query);

More Example Queries

You will find complete information on the driver's supported SQL in the help documentation. The code examples above are PDFMonkey-specific adaptations of the PHP community documentation for all ODBC functions.