前提条件
SuiteCRM V8 API は認証に OAuth を使用するため、OAuthClient および OAuthPassword の認証方法ではカスタム OAuth アプリケーションが必要です。Basic 認証方法で SuiteCRM V4.1 API に接続する場合は、本セクションをスキップできます。
カスタム OAuth アプリケーションは SuiteCRM の管理者が作成・登録する必要があります。SuiteCRM でカスタム OAuth アプリケーションを作成するには、以下の手順に従います：
管理者クレデンシャルで SuiteCRM アカウントにログインします。
Profile ドロップダウンで Admin > OAuth2 Clients and Tokens を選択します。
OAuthClient メソッドの場合は New Client Credentials Client、OAuthPassword メソッドの場合は New Password Client をクリックします。
アプリケーションの Name と Secret を入力し、Save をクリックします。
生成されたクライアント ID とクライアントシークレットを取得します。これらの値を以下のセットアップ手順で OAuth Client Id と OAuth Client Secret として入力します。
OAuthClient（クライアントクレデンシャル）グラントタイプで認証するユーザーは、API へのフルアクセスを持ちます。OAuthPassword グラントタイプで認証するユーザーは、アクセスする各モジュールまたはテーブルに対する権限が必要です。
セットアップガイド
以下の手順で、SuiteCRM を Connect AI アカウントに接続します：
Connect AI のナビゲーションメニューから Sources ページを開きます。
右上の + Add Connection をクリックします。
検索フィールドに SuiteCRM と入力し、データソース名をクリックします。
新しいコネクションの Basic Settings タブで、コネクション名を入力するかデフォルトの名前をそのまま使用します。
SuiteCRM API バージョンに合った Schema を選択します：SuiteCRM V4.1 API の場合は suitecrmv4、SuiteCRM V8 API の場合は suitecrmv8 です。
SuiteCRM への接続時に使用する Auth Scheme を選択し、以下の該当するセクションの手順に従います。
Basic
OAuthClient
OAuthPassword
Schema が suitecrmv4 に設定されていることを確認します。Basic 認証方法は SuiteCRM V4.1 API でのみサポートされています。
認証ユーザーの Id である User を入力します。
Connect AI Add Connection ページ上部の、Save & Test をクリックします。
- 接続テストに成功すると、コネクションが作成されたことを示すConnection successfully saved というメッセージが表示されます。Edit Connection ページのStatus もAuthenticated に変わります。Edit Connection ページの右ペインにあるData Model タブで、成功したコネクションのデータモデルを表示します。
- 接続テストに失敗した場合は、入力したログイン情報に余分なスペースや文字がないかを確認してください。Connect AI は、データが不足している必須フィールドの下にエラーメッセージを表示します。一部のデータソースでは、ソースのWeb サイトに直接サインインする必要があります。サインインしていない場合は、Sign in ボタンの下にエラーメッセージが表示されます。エラーを修正し、もう一度試してください。
- 失敗したコネクションは下書きとして保存され、Status はNot Authenticated になります。後でコネクションに戻って認証することができます。
Schema が suitecrmv8 に設定されていることを確認します。OAuthClient 認証方法は SuiteCRM V8 API でのみサポートされています。
カスタム OAuth アプリケーションに割り当てられた OAuth Client Id（コンシューマーキーとも呼ばれます）を入力します。
カスタム OAuth アプリケーションに割り当てられた OAuth Client Secret を入力します。
Connect AI Add Connection ページ上部の、Save & Test をクリックします。
- 接続テストに成功すると、コネクションが作成されたことを示すConnection successfully saved というメッセージが表示されます。Edit Connection ページのStatus もAuthenticated に変わります。Edit Connection ページの右ペインにあるData Model タブで、成功したコネクションのデータモデルを表示します。
- 接続テストに失敗した場合は、入力したログイン情報に余分なスペースや文字がないかを確認してください。Connect AI は、データが不足している必須フィールドの下にエラーメッセージを表示します。一部のデータソースでは、ソースのWeb サイトに直接サインインする必要があります。サインインしていない場合は、Sign in ボタンの下にエラーメッセージが表示されます。エラーを修正し、もう一度試してください。
- 失敗したコネクションは下書きとして保存され、Status はNot Authenticated になります。後でコネクションに戻って認証することができます。
Schema が suitecrmv8 に設定されていることを確認します。OAuthPassword 認証方法は SuiteCRM V8 API でのみサポートされています。
カスタム OAuth アプリケーションに割り当てられた OAuth Client Id（コンシューマーキーとも呼ばれます）を入力します。
カスタム OAuth アプリケーションに割り当てられた OAuth Client Secret を入力します。
認証ユーザーの Id である User を入力します。
Connect AI Add Connection ページ上部の、Save & Test をクリックします。
- 接続テストに成功すると、コネクションが作成されたことを示すConnection successfully saved というメッセージが表示されます。Edit Connection ページのStatus もAuthenticated に変わります。Edit Connection ページの右ペインにあるData Model タブで、成功したコネクションのデータモデルを表示します。
- 接続テストに失敗した場合は、入力したログイン情報に余分なスペースや文字がないかを確認してください。Connect AI は、データが不足している必須フィールドの下にエラーメッセージを表示します。一部のデータソースでは、ソースのWeb サイトに直接サインインする必要があります。サインインしていない場合は、Sign in ボタンの下にエラーメッセージが表示されます。エラーを修正し、もう一度試してください。
- 失敗したコネクションは下書きとして保存され、Status はNot Authenticated になります。後でコネクションに戻って認証することができます。
詳細について
Connect AI と SuiteCRM の連携の詳細動作については、こちらのページを参照してください。
