メインコンテンツにスキップ

データコネクタ クイックスタートガイド

Fin Data connectorsを初めて使う方へ。このガイドでは、コネクタ作成からAPI、認証、カスタムオブジェクト、テスト、トラブルシューティングまでの全設定を説明します。

対応者:Beth-Ann Sher

Data connectorsは、Finが会話中に注文詳細、アカウント状況、サブスクリプション情報などの外部システムのライブデータにアクセスできるようにし、人が調べる必要をなくします。この記事は完全な設定プロセスの目次です。初めての場合は順に、復習したい場合は特定のトピックにジャンプしてください。


開始前に

まず概念の概要を読んでください。データコネクタとカスタムオブジェクトとは何か、それらの関係、どちらが必要かを説明します。

ステップ1:API設計とコネクタの設定

まずAPIを設計し、Data connectorを作成してAPIの呼び出し方法を定義します。

  • Designing and using your APIs with Data connectors — Fin data connectorsと連携するAPIエンドポイントの構造について説明。コネクタ設定前に読むこと。

  • How to set up Data connectors — API(データ入力とAPIエンドポイント)、データ(APIレスポンスの整形)、Fin(Finがコネクタをトリガーする方法)、セキュリティ(アクセス制御と本番稼働)を含む4つの設定フェーズを詳細に解説。

  • Use Data connector templates — ワークスペースにインストールされたサードパーティアプリを使い、データコネクタテンプレートから素早く開始。

ステップ2:認証とセキュリティ

本番稼働前に、コネクタが外部APIとどのように認証するか、顧客がデータにアクセスする前に認証が必要かを設定します。

重要: 顧客認証を強制しないと、悪意のある者がusersを偽装してデータにアクセスする可能性があります。最低でもSecurityタブの組み込みチェックを確認してからコネクタを本番稼働させてください。

ステップ3:レスポンススキーマ、オブジェクト、配列

APIのレスポンス形状はFinが返されたデータを読み取り利用する方法を決定します。このセクションでは異なるレスポンス構造の扱い方を説明します。

ステップ4:カスタムオブジェクトとプロパティ

カスタムオブジェクトは、標準の連絡先や会話属性では捉えられない注文、サブスクリプション、予約などの構造化された複数プロパティのデータをIntercomに保存できます。通常はコネクタのレスポンスデータをオブジェクトにマッピングして入力します。

  • Setting up a Custom Object — オブジェクトタイプの作成、プロパティの定義、データコネクタ経由でのオブジェクトの入力、PeopleやConversationオブジェクトへの参照設定を解説。

ステップ5:オブジェクトマッピング

オブジェクトマッピングは、APIレスポンスデータをIntercomのどこに保存するかをコネクタに指示します。標準オブジェクト(連絡先や会話属性)またはカスタムオブジェクトにマッピング可能です。APIレスポンスフィールドを属性にマッピングするには、How to set up Data connectorsのオブジェクトマッピングセクションを参照してください。

ステップ6:テスト

各コネクタには組み込みのテストツールがあり、本番稼働前にAPI呼び出しとレスポンス形状を検証できます。コネクタのDataタブのTest connectionボタンでリクエストとレスポンス全体を確認してください。Finが会話でコネクタを使うエンドツーエンドテストには、audience rulesで自分のuser emailをターゲットに設定します。

ステップ7:Fin手順でのData connectorsの使用

FinはData connectorを直接呼び出して顧客の質問に答えられますが、コネクタはより複雑な多段階手順の基本構成要素でもあります。例えば注文を検索し、更新を提案し、変更を確認するなどです。

トラブルシューティングとよくある質問

コネクタが期待通りに動作しない場合はトラブルシューティング記事から始めてください。セキュリティやプライバシーの質問はFAQ記事でよくある懸念をカバーしています。


クイックリファレンス:すべてのData connector記事

この表を使ってData connectorsドキュメント内の任意の記事に直接ジャンプできます。

記事

内容

コアコンセプトと使用タイミング

Finと連携するAPIエンドポイントの構造

主要なコネクタ設定ガイド、4つの設定フェーズを詳細に解説

サードパーティアプリを使ったクイックスタートテンプレート

認証トークン、資格情報、顧客認証

セキュリティチェック、本番稼働前のベストプラクティス

レスポンススキーマ、ネストオブジェクト、配列、XML

カスタムオブジェクトタイプ、プロパティ、コネクタ経由での入力

カスタムオブジェクトと他オブジェクト間の参照

Finの使用状況と健全性指標

Data connectorのユースケースと例

Finが外部APIデータを読み取り、操作を実行する方法

Workflow/Inboxのユースケース、オブジェクトマッピングの詳細

Data connectorのログとエラー

一般的な失敗と修正方法

プライバシー、セキュリティ、よくある質問

こちらの回答で解決しましたか?