Natively Connect to Superchat Data in PHP

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

Superchat uses API Key authentication. The API key is passed via the X-API-KEY request header on every call.

Authentication

To authenticate to Superchat, you need to obtain your API key from the Superchat workspace settings.

Using API Key Authentication

You can obtain your API key from Settings > Integrations > API Key in your Superchat workspace.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Superchat API key.

Example connection string:

Profile=C:\profiles\Superchat.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

Establish a Connection

Open the connection to Superchat 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 Channels WHERE = ?");

Execute Queries

Execute prepared statements with .

$conn = odbc_connect("CData ODBC API Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Channels 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 Channels WHERE = ''");
 

Process Results

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

$conn = odbc_connect("CData ODBC Superchat data Source","user","password");
$query = odbc_exec($conn, "SELECT , FROM Channels 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 Superchat data Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Channels 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 Superchat-specific adaptations of the PHP community documentation for all ODBC functions.