Access Kintone Data from MySQL in PHP

You can use the CData SQL Gateway and ODBC Driver for Kintone to access Kintone data from MySQL clients, without needing to perform an ETL or cache data. Follow the steps below to connect to Kintone data in real time through PHP's standard MySQL interfaces, mysqli and PDO_MySQL.

Connect to Kintone Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Kintone data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

👁 Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Connect in PHP

The following examples show how to use object-oriented interfaces to connect and execute queries. Initialize the connection object with the following parameters to connect to the virtual MySQL database:

• Host: Specify the remote host location where the service is running. In this case "localhost" is used for the remote host setting since the service is running on the local machine.
• Username: Specify the username for a user you authorized on the SQL Gateway's Users tab.
• Password: Specify the password for the authorized user account.
• Database Name: Specify the system DSN as the database name.
• Port: Specify the port the service is running on; port 3306 in this example.

mysqli

<?php
$mysqli = new mysqli("localhost", "user", "password", "CData Kintone Sys","3306");
?>

PDO

<?php
$pdo = new PDO('mysql:host=localhost;dbname=CData Kintone Sys;port=3306', 'user', 'password');
?>

Query in PHP

With the connection established, you can then access tables. The following steps walk through the example:

1. Query the table; for example, Comments. The results will be stored as an associative array in the $result object.
2. Iterate over each row and column, printing the values to display in the PHP page.
3. Close the connection.

mysqli

$result = $mysqli->query("SELECT CreatorName, Text FROM Comments WHERE AppId = '1354841'");
while($row = $result->fetch_assoc()) {
 foreach ($row as $k=>$v) {
 echo "$k : $v";
 echo "<br>"; 
 }
}
$mysqli->close();

PDO

$result = $pdo->query("SELECT CreatorName, Text FROM Comments WHERE AppId = '1354841'");
while($row = $result->fetch(PDO::FETCH_ASSOC)) {
 foreach ($row as $k=>$v) {
 echo "$k : $v";
 echo "<br>"; 
 }
}
$result = null;
$pdo = null;