コネクタ内で利用可能なオブジェクトは、"cdata.cloudant" モジュールからアクセスできます。モジュールのオブジェクトを直接使用するには：

1. モジュールを以下のようにインポートします。
   

   import cdata.cloudant as mod

2. 接続を確立するには、以下のような適切な接続文字列を使用してコネクタオブジェクトからconnect() メソッドを呼び出します。
   

   mod.connect("User=abc123; Password=abcdef;")

Cloudant への認証

Cloudant は2種類の認証をサポートします。

• OAuth：OAuth 規格に基づいた認証を行います。AuthScheme をOAuth に設定し、Cloudant インスタンスのAPIKey とURL の値を指定します。
• Basic：基本的なユーザー名 / パスワード認証。AuthScheme をBasic に設定します。

IBM Cloud IAM

IBM Cloud IAM is OAuth-based authentication accessed via a web browser.

To authenticate to IBM Cloud, set AuthScheme to OAuth and supply the ApiKey and the Url of the target Cloudant instance (for example, https://0c9d3837-8304-4aab-a65a-648169970943-bluemix.cloudant.com).

After setting InitiateOAuth to GETANDREFRESH, you are ready to connect.

When you connect, the 本製品 completes the OAuth process.

1. Extracts the access token and authenticates requests.
2. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Retrieving OAuth connection properties

To retrieve the OAuth connection properties:

1. Create an account in IBM Cloud.
2. Obtain the ApiKey:
   1. Log in to your IBM Cloud account.
   2. Navigate to Platform API Keys page.
   3. To create a new API Key, click Create an IBM Cloud API Key. Cloudant displays a pop-up form.
   4. Specify the API Key name and click Create. Cloudant displays the ApiKey you just created.
      Save this information for future reference.

Registering a new instance of Cloudant

If you do not already have Cloud Object Storage in your IBM Cloud account, you can install an instance of SQL Query in your account:

1. Log in to your IBM Cloud account.
2. Navigate to the Cloudant page.
3. Choose a name for your instance and click Create. You are redirected to that Cloudant instance.

IBM Cloudant Legacy

IBM Cloudant Legacy 経由で接続するには、有効なIBM Cloudant サービスクレデンシャルを持っていることを確認してください。

IBM Cloudant のサービスクレデンシャルを作成するには：

1. IBM Cloud ダッシュボードにログインします。
2. Menu icon -> Resource List に移動し、IBM Cloudant サービスインスタンスを開きます。
3. メニューで、Service credentials をクリックします。
4. New credential をクリックします。Cloudant はAdd new credential ウィンドウを表示します。
5. 新しい資格情報の名前を入力します。
6. Add をクリックします。 資格情報がService credentials テーブルに追加されます。
7. Actions -> View credentials をクリックします。
8. JSON ファイルからUser およびPassword の値を取得します。

取得した値を使用して、User およびPassword を設定します。

ローカルインスタンスへの認証

Cloudant は、バージョン1.1.0以上のローカルインスタンスのデータへの認証をサポートします。

ローカルインスタンスへの認証を行うには、次のパラメータを設定します。

1. Url：ローカルインスタンスのURL。例： http://localhost:8006
2. User：ユーザーネーム。
3. Password：パスワード。