Natively Connect to Kintone Data in PHP

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

In addition to the authentication values, set the following parameters to connect to and retrieve data from Kintone:

• Url: The URL of your account.
• GuestSpaceId: Optional. Set this when using a guest space.

Authenticating with Kintone

Kintone supports the following authentication methods.

Using Password Authentication

You must set the following to authenticate:

• User: The username of your account.
• Password: The password of your account.

Using Basic Authentication

If the basic authentication security feature is set on the domain, supply the additional login credentials with BasicAuthUser and BasicAuthPassword. Basic authentication requires these credentials in addition to User and Password.

Using Client SSL

Instead of basic authentication, you can specify a client certificate to authenticate. Set SSLClientCert, SSLClientCertType, SSLClientCertSubject, and SSLClientCertPassword. Additionally, set User and Password to your login credentials.

Establish a Connection

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

$conn = odbc_connect("CData ODBC Kintone 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 Kintone 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 Comments WHERE AppId = ?");

Execute Queries

Execute prepared statements with .

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

Execute nonparameterized queries with .

$conn = odbc_connect("CData ODBC Kintone Source","user","password");
$query = odbc_exec($conn, "SELECT CreatorName, Text FROM Comments WHERE AppId = '1354841'");
 

Process Results

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

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

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

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