AIエージェント(Advanced)は、バックエンドシステムに対してサーバー間のHTTPリクエストを実行します。リクエストは、ユーザーパスが対話内のインテグレーションノードをトリガしたときに開始され、マッピングされ返されたデータは保存され、AIエージェント(Advanced)セッションの間、使用できます。
バックエンドAPIの技術要件
APIのタイプ
APIは、以下のアーキテクチャのいずれかである必要があります。
- REST
- GraphQL
レスポンス
APIレスポンスは、一般的な要件に従う必要があります。
- 30秒以内にAPIレスポンスを提供する
- JSON形式を返すことが望ましい
認証
AIエージェント(Advanced)側では、次のいずれかを使用して認証できます。
- APIキー
- ベアラートークン
- 有効期限トークン
- 基本認証
- OAuth 2.0
- IPセーフリスト/許可リスト
セルフチェックリスト
以下のセルフチェックリストには、堅牢なAPIの構築に役立つ質問と情報が記載されています。
- APIは、一般的なユーザーが知っているようなデータ、またはCRMから渡されたデータで「検索可能」ですか?
- APIレスポンスのデータには、ユースケースを満たす情報が含まれていますか?
- ユースケースで複数のシステムのデータが必要な場合、それらを中間レイヤに統合できますか?
- APIが200、400、および404 HTTPステータスコードをスローするタイミングは分かりますか?
- 入力が無効または間違っている場合、APIは何を返しますか?
- システムはAPI制限を設定していますか?
- システムはレスポンスの送信にどのくらい時間がかかりますか?
準備するもの:
• ドキュメント:認証、APIリクエストのクエリ/本文、レスポンススキーマ
• (任意のPostmanコレクション)
• 最も一般的な結果のテストデータ
オンボーディングプランの詳細については、前回の記事カスタムインテグレーション - 準備を参照してください。