You can create and manage connections with the Data Explorer and the FireDAC Connection Editor wizards. See Connection Definitions for more information on creating connections from code and creating persistent, private, or temporary connections.

Connecting to Kintone

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 to Kintone

Kintone supports the following authentication methods.

Password Authentication

You must set the following to authenticate to Kintone:

• User: The username of your account.
• Password: The password of your account.
• AuthScheme: Set AuthScheme to Password.

API Token

You must set the following to authenticate to Kintone:

• APIToken: The API Token.

  To generate an API token access the specific app and click on the cog wheel. Proceed to App Settings tab > API Token. Click on the Generate button, an API token will be generated.

• AppId: The Application Ids.

  The AppId is the number of that specific app in the sequence under Apps in Kintone UI dashboard.

• AuthScheme: Set AuthScheme to APIToken.

Additional Security

In addition to the mentioned authentication schemese, Kintone offers additional security in the form of both an additional Basic Auth header, and an SSL Certificate.

Using Client SSL

In addition to your authentication information, Kintone may be configured to require an SSL certificate to accept requests. To do so, set the following:

• SSLClientCert: The file containing the certificate of the SSL Cert. Or alternatively, the name of the certificate store for the client certificate.
• SSLClientCertType: The type of certificate.
• SSLClientCertSubject: (Optional) If searching for a certificate in the certificate store, the store is searched for subjects containing the value of the property.
• SSLClientCertPassword: If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.

Basic

Kintone environments using basic authentication will need to pass additional basic credentials. To do so, specify the following:

• BasicAuthUser: The basic login name.
• BasicAuthPassword: The basic password.

Using the FireDAC Connection Editor

Complete the following steps to use the FireDAC Connection Editor to assign a Kintone connection to a TFDConnection object:

1. Open a project and drop a TFDPhysCDataKintoneDriverLink from the Tool Palette onto the Form Designer.
2. Drop a TFDConnection object onto the Form Designer.
3. Double-click the TFDConnection and select CDataKintone in the Driver Id menu.
4. Define the necessary connection properties.
5. To execute ad-hoc SQL statements based on this connection, enter SQL commands on the SQL Script tab.
6. In the Form Designer, select the TFDConnection object and set the Connected property to true.

Using the Data Explorer

Complete the following steps to use the Data Explorer to define persistent connections that can be shared across applications and projects:

1. Click View > Tool Windows > Data Explorer in RAD Studio and expand the FireDAC node.
2. Right-click the CData Kintone Data Source node and click Add New Connection.
3. Enter a name for the connection. The FireDAC Connection Editor opens.

Working with Persistent Connections

The connections you define in the Data Explorer can be assigned to a TFDConnection object by specifying the connection name in the TFDConnection object's ConnectionDefName property.

Browsing Data and Metadata

The Data Explorer also provides options for browsing Kintone objects at design time:

• Expand the CData Kintone Data Source node in the Data Explorer to view the defined connections.
• Expand a connection node to find the database objects available for a connection.
• Drill down to a database object to find metadata such as primary keys.
• To display data, double-click a table or view or right-click and click View.