データコネクターは、Finが会話中に注文詳細、アカウント状況、サブスクリプション情報などの外部システムのライブデータにアクセスできるようにし、人が調べる必要をなくします。この記事は完全な設定プロセスの目次です。初めての場合は順番に、復習したい場合は特定のトピックにジャンプしてください。
始める前に
まず概念の概要を読んでください。データコネクターとカスタムオブジェクトとは何か、それらの関係、どちらが必要かを説明します。
データコネクターとカスタムオブジェクトの説明 — コアコンセプト、コネクターとカスタムオブジェクトの関係、FinコネクターとWorkflowコネクターの違いをカバー。
ステップ1: APIを設計しコネクターを設定する
まずAPIを設計し、次にデータコネクターを作成してAPIの呼び出し方法を定義します。
データコネクターでAPIを設計・使用する方法 — Finのデータコネクターと相性の良いAPIエンドポイントの構造について説明。
データコネクターの設定方法 — API(データ入力とAPIエンドポイント)、データ(APIレスポンスの整形)、Fin(Finがコネクターをトリガーする方法)、セキュリティ(アクセス制御と本番稼働)を含む4つの設定フェーズを詳細に解説。
データコネクターテンプレートの使用 — ワークスペースにインストールされたサードパーティアプリを使ってテンプレートから素早く開始。
ステップ2: 認証とセキュリティ
本番稼働前に、コネクターが外部APIとどのように認証するか、顧客がデータにアクセスする前に認証が必要かを設定します。
データコネクターの認証設定 — 認証トークンの種類(テキスト、OAuth、JWT)、資格情報ページ、個別コネクターでの顧客認証の有効化方法を解説。
ワンタイムパスコードでデータコネクターを保護 — Finが顧客データを公開する前にOTP認証を強制。
Finでデータコネクターを使用する際のベストプラクティス — セキュリティタブの組み込みチェック、一般的なリスク、本番稼働前の推奨事項をカバー。
重要: 顧客認証を強制しないと、悪意のある第三者がusersをなりすまし、データにアクセスする可能性があります。最低でもセキュリティタブの組み込みチェックを確認してからコネクターを本番稼働させてください。
ステップ3: レスポンススキーマ、オブジェクト、配列
APIのレスポンスの形状はFinが返されたデータをどのように読み取り使用するかを決定します。このセクションでは異なるレスポンス構造の扱い方を説明します。
データコネクターのレスポンスマッピングでサポートされるJSONオブジェクトと配列 — フラットオブジェクト、ネストオブジェクト、配列、XMLレスポンス(自動的にJSONに変換)をカバー。複雑またはネストされたデータを返すAPIの場合に参照してください。
ステップ4: カスタムオブジェクトとプロパティ
カスタムオブジェクトは、標準の連絡先や会話属性では捉えられない注文、サブスクリプション、予約などの構造化された複数プロパティのデータをIntercomに保存できます。通常、コネクターのレスポンスデータをオブジェクトにマッピングして入力します。
カスタムオブジェクトの設定 — オブジェクトタイプの作成、プロパティの定義、データコネクター経由でのオブジェクトの入力、PeopleおよびConversationオブジェクトへの参照設定をカバー。
ステップ5: オブジェクトマッピング
オブジェクトマッピングは、APIレスポンスデータをIntercomのどこに保存するかをコネクターに指示します。標準オブジェクト(連絡先および会話属性)またはカスタムオブジェクトにマッピングできます。
カスタムオブジェクトでの参照設定 — APIレスポンスフィールドをIntercomの連絡先または会社属性に直接マッピングし、外部システムからIntercomワークスペースへのデータ同期を自動化。
WorkflowsとInbox用データコネクターの設定方法 — カスタムオブジェクトへのマッピング詳細、external_id要件を含む追加情報。
ステップ6: テスト
各コネクターには組み込みのテストツールがあり、本番稼働前にAPI呼び出しとレスポンスの形状を検証できます。コネクターのDataタブのTest connectionボタンを使って完全なリクエストとレスポンスを確認してください。Finが会話でコネクターを使用するエンドツーエンドテストには、audienceルールで自分のuserメールをターゲットに設定します。
データコネクターの安全な展開方法 — データコネクターの監視と管理、inboxでの活動状況の確認方法を説明。
ステップ7: Finの手順でのデータコネクターの使用
Finは顧客の質問に直接答えるためにデータコネクターを呼び出せますが、コネクターはより複雑な多段階の手順の基本構成要素でもあります。例えば、注文を調べて更新を提案し、変更を確認するなどです。
Finの手順でデータコネクターを使う方法 — Finが外部APIデータを読み取り、顧客との会話中に自動アクションを実行する方法を教えます。
トラブルシューティングとよくある質問
コネクターが期待通りに動作しない場合はトラブルシューティング記事から始めてください。セキュリティとプライバシーの質問はFAQ記事で最も一般的な懸念をカバーしています。
データコネクターエラーの理解 — データコネクターログの読み方、エラー原因の特定、解決手順を教えます。
Finの手順とデータコネクターのトラブルシューティング — テストは通るが本番手順で失敗するコネクター、入力エラー、レスポンス解析問題などの一般的な失敗パターンをカバー。
データコネクターFAQ — データプライバシー、セキュリティ、なりすましリスク、その他よくある質問をカバー。
クイックリファレンス: すべてのデータコネクター記事
この表を使ってデータコネクターのドキュメント内の任意の記事に直接ジャンプできます。
記事 | 内容 |
コアコンセプトと使用タイミング | |
Finと相性の良いAPIエンドポイントの構造 | |
主要なコネクター設定ガイド、4つの設定フェーズを詳細に解説 | |
サードパーティアプリを使ったクイックスタートテンプレート | |
認証トークン、資格情報、顧客認証 | |
セキュリティチェック、本番稼働前のベストプラクティス | |
レスポンススキーマ、ネストオブジェクト、配列、XML | |
カスタムオブジェクトタイプ、プロパティ、コネクター経由での入力 | |
APIレスポンスのIntercom属性へのマッピング | |
Finの使用状況と健全性指標 | |
データコネクターのユースケースと例 | |
Finが外部APIデータを読み取り、アクションを実行することを許可 | |
Workflow/Inboxのユースケース、オブジェクトマッピングの詳細 | |
データコネクターログとエラー | |
一般的な失敗と修正方法 | |
プライバシー、セキュリティ、よくある質問 |
