Natively Connect to iContact Data in PHP

Drop the CData ODBC Driver for iContact into your LAMP or WAMP stack to build iContact-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to iContact 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 iContact Profile on disk (e.g. C:\profiles\IContact.apip). Next, set the ProfileSettings connection property to the connection string for iContact (see below).

iContact API Profile Settings

In your iContact account, navigate to Settings & Billing > Integrations and create a Custom API Integration. Your AppId, Username, Password, and AccountId are all available on the Getting Connected page of that integration.

Establish a Connection

Open the connection to iContact 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 Campaigns WHERE Name = ?");

Execute Queries

Execute prepared statements with odbc_execute.

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

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC API Source","user","password");
$query = odbc_exec($conn, "SELECT ClientFolderId, CampaignId FROM Campaigns WHERE Name = 'Summer Newsletter 2024'");
  

Process Results

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

$conn = odbc_connect("CData ODBC iContact data Source","user","password");
$query = odbc_exec($conn, "SELECT ClientFolderId, CampaignId FROM Campaigns WHERE Name = 'Summer Newsletter 2024'");
while($row = odbc_fetch_array($query)){
 echo $row["ClientFolderId"] . "\n";
}

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

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