DEBUG用エリア 

記事テンプレート

API連携の初期設定

Knowledge Suite+にはAPI連携(Webhook通知)およびMCP連携の機能がございます。
本ドキュメントではAPI連携の初期設定・セットアップ方法をご紹介いたします。
 

【この記事の内容】

 


 

API連携について

API連携(Application Programming Interface)は、外部システムが本システムの公開インターフェースにリクエストを送り、データの取得・登録・更新・削除を行う通信の仕組みです。例えば、本システムに登録されている顧客データや商品データを取得して、外部の販売管理システムにデータ登録やデータ同期させる事ができます。
通信は連携元のシステムから始まり、必要なときに必要な情報を取りに行く「プル型」の方式です。
 

Webhook通知について

Webhook通知は、本システムで特定イベント(取引先登録/更新、商談ステータス更新など)が起きたときに、それをトリガーとして登録された外部URL(エンドポイント)へ、その特定イベント内容を自動通知します。
分かりやすく書くと「向こうから知らせてくれる」通信の仕組みです。通信はイベントが起きたシステムから始まり、変化があったときにだけ情報が届く「プッシュ型」の方式です。
 

想定されるユースケース

① マーケティングと営業をつなぐ(MAツールとの連携)
MAツールでメールを配信している見込み客と、KS+の取引先担当者のデータを同期します。
さらに、メールの開封数やクリック数が多い見込み客については、KS+の案件フェーズを「メール対象」から「架電アプローチ対象」に自動で更新します。
営業担当者はKS+を開くだけで、今どの見込み客に電話をかけるべきかをその場で判断できます。

② 受注後の販売管理とつなぐ
KS+で案件が「受注」フェーズに更新されたことをきっかけに、販売管理システムへ情報を連携します。
販売管理システム側に該当する得意先や商品のデータがない場合は、あわせて登録します。
受注のたびに発生していた販売管理システムへの転記と二重入力がなくなり、入力ミスによる請求や出荷の誤りも防げます。

③ 自社独自のAIエージェントを組み立て、「AIセキュアランチャー」から実行する
外部システムのAPI、LLM(大規模言語モデル)のAPI、そしてSFA機能のAPIをDifyのワークフローで組み合わせることで、自社の業務に合わせたAIエージェントを構築できるようになります。構築したAIエージェントは、「AIセキュアランチャー」から社内のメンバーが安全に呼び出して利用できます。
たとえば、Zoomで実施した商談の音声や文字起こしをAIが解析・要約し、KS+の案件メモと営業報告に登録。
続いて、お礼メールの文面をAIが作成してOutlookから送信し、案件のフェーズも更新する。
商談後に営業担当者が一つずつ行っていた作業を、AIエージェントが代わりに実行します。
 

セットアップ前の注意事項

【利用規約について】
API連携・Webhook通知・MCP連携をご利用の場合は、以下の利用規約をご一読ください。
 Knowledge Suite+サービス利用規約
 Knowledge Suite+ API・MCP利用規約
※API・Webhook・MCPを利用した不正利用は一切禁止しております。また情報漏洩等のトラブルにつきましては当方では責任を負いかねます。
 セキュリティ対策等の管理は、ユーザー様の責任において実施いただきますようお願い申し上げます。

【クライアントIDやAPIキー等の取り扱いについて】
初期設定で扱うROBOTIDの企業ユニークID、ユーザーID、パスワード、およびクライアントID、クライアントシークレット等の認証情報は厳重に管理してください。
外部への漏洩防止はもちろん、生成AIに入力・読み込ませることがないよう、細心の注意を払ってご利用ください。

【Knowledge Suite+管理者設定について】
・API連携・MCP連携をご利用の場合は「外部連携API」のロールが付与されている事をご確認ください。
・Webhook通知をご利用の場合は管理者設定画面の設定をご確認ください。
 

ROBOT IDで企業ユニークIDを確認する

まずは下記ROBOTIDのURLへアクセスし、KS+のユーザーIDとパスワードを使用してログインしてください。
https://robotid.jp/idaas/console/f/login


右上のアカウント名を押下します。マイアカウントを開き、企業ユニークIDを確認してください。

 

Open ID Connect管理コンソールにログインする

1.ROBOT IDのホーム画面より「KSPlusOpenId」を押下します。

2.Open ID Connect管理コンソールで企業ユニークIDとアカウント情報を入力します。

3.ROBOT IDのOpen ID Connect管理コンソールが開きます。[クライアント情報設定]を押下します。

4.[新規作成]を押下し、下記のとおり各項目を入力します。下記以外の項目は初期値のままで問題ありません。

クライアントID 「IDを手動で入力」にチェックを入れない場合は、ランダムな文字列が自動で入力されます。
任意のクライアントIDを設定したい場合は、チェックを入れて入力してください。
クライアントシークレット 「シークレットを手動で入力」にチェックを入れない場合は、自動で入力されます。
クライアントシークレットは、社外の第三者に知られないよう厳重に管理してください。
クライアント名(必須) クライアント一覧画面に表示される名称です。
用途が分かる任意の名称を入力してください。

5.項目の入力後、[保存]を押下します。

6.作成したクライアントの[編集]を押下し、表示されたクライアントIDとクライアントシークレットを控えます。

すでにクライアントを作成済みの場合は新規作成せず、既存のクライアントの[編集]を押下し、クライアントIDとクライアントシークレットを控えてください。情報ダウンロードを押下するとJSONファイルとして取得できます。

解決しましたか?
0人中0人がこの記事が役に立ったと言っています