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