MuleSoft Connector for kintone

Build 21.0.7930

Establishing a Connection

This section describes how to connect to kintone from your AnyPoint Studio project. You can use wizards or the XML editor in AnyPoint Studio to define connection properties in a global element. Global elements can be reused across other building blocks in your project.

Create a Connection in the Visual Editor

Complete the following steps to visually add the connector to your project and create a connection:

  1. Create a new Mule Project in Anypoint Studio.
  2. From the palette, drag the connector into your Mule flow.
  3. On the Message Flow canvas, double-click the connector icon to open the connector properties in the Properties pane.
  4. In the General section, click Add and define the kintone connection properties. Note that the user name and Password properties always appear here. The user name must be set as it is used as the key for the connection if connection pooling is enabled.

Create a Connection in the XML Editor

Set connection properties in the <cdata-kintone:config> element in the root of the project's XML.

Note: The user name attribute must always be included here and serves as the key for the connection if connection pooling is enabled.

  <cdata-kintone:config name="CData_Kintone_Configuration" username="MyName" connectionProperty1="MyProperty" ... doc:name="CData Kintone: Configuration"/> 

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.

Using 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.

Using APIToken Authentication

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.

Using Basic Auth

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.

Configure Connector Operations

The connector is an operation-based connector; its operations correspond to SQL statements and expose other functionality such as Schema Discovery. See Using the Connector (Mule 3.8+) for more information on executing SQL to kintone in Mule applications.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930