Learn more
 

Ready to get started?

Connect to live data from Klipfolio with the API Driver

Connect to Klipfolio

In this article

Related articles

Natively Connect to Klipfolio Data in PHP


The CData ODBC driver for Klipfolio enables you to create PHP applications with connectivity to Klipfolio data. Leverage the native support for ODBC in PHP.

Drop the CData ODBC Driver for Klipfolio into your LAMP or WAMP stack to build Klipfolio-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to Klipfolio 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.

Start by setting the Profile connection property to the location of the Klipfolio Profile on disk (e.g. C:\profiles\Klipfolio.apip). Next, set the ProfileSettings connection property to the connection string for Klipfolio (see below).

Klipfolio API Profile Settings

In order to authenticate to Klipfolio, you'll need to provide your API Key. You can generate an API key from the Klipfolio Dashboard app through either the My Profile page or from Users if you are an administrator (you must have the user.manage permission). Set the API Key in the ProfileSettings property to connect.

Establish a Connection

Open the connection to Klipfolio by calling the odbc_connect or odbc_pconnect methods. To close connections, use odbc_close or odbc_close_all.

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

Connections opened with odbc_connect are closed when the script ends. Connections opened with the odbc_pconnect 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 odbc_prepare function.

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

Execute Queries

Execute prepared statements with odbc_execute.

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

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC API Source","user","password"); $query = odbc_exec($conn, "SELECT Id, Name FROM DataSources WHERE IsDynamic = 'true'");

Process Results

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

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

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

$conn = odbc_connect("CData ODBC Klipfolio data Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM DataSources WHERE IsDynamic = ?"); $success = odbc_execute($query, array('true')); 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 Klipfolio-specific adaptations of the PHP community documentation for all ODBC functions.