API タスク リアルタイム エンドポイント
- 最終更新日2024/10/31
API タスク リアルタイム エンドポイント
リアルタイム エンドポイントで API タスクを即座に呼び出します。API タスク実行 URL とトークンを生成し、API エンドポイントから API タスク実行を開始できます。
主なメリット
- プログラム的デプロイ: お好みの API クライアントを使用して、リアルタイムでどこからでも API タスクを呼び出します。
- 応答時間: 低レイテンシーで、ほぼリアルタイムの応答速度を実現するように設計されており、ほとんど即座に (通常はミリ秒以内に) 応答することを目指しています。
-
処理:
- オートメーションはクラウドにロードされ、いつでもリクエストを受け付けることができます。これにより、迅速な処理と対応が可能になります。
- プレミアム ライセンスではオートメーションが拡張され、クラウド リソースの大規模なプールにアクセスして API タスクの複数のインスタンスを実行できるため、並行性が高まり、より多くの API タスク リクエストを同時に処理できるようになります。
-
使用事例:
- チャットボットのようなインタラクティブな状況に最適
- リアルタイムの不正検知
- オンライン ケース作成
- 即座の応答が重要な事例
前提条件
- 必ず API タスクを作成してください。API タスクの作成の詳細については、「API タスクを作成」を参照してください。
- API タスクをチェックインしている必要があります。API タスクのチェックインについての詳細は、「リポジトリに API タスクをチェックインする」を参照してください。
以下のサンプル コード スニペットでは、API タスクをリアルタイムでクラウド デバイスにデプロイする手順について説明しています。また、変数は、デプロイされたときに API タスクに渡すこともできます。
- ステップ 1: API タスク リアルタイム エンドポイント - 認証
- Control Room インスタンスへのアクセスを認証します。
- ステップ 2: API タスク割り当ての作成 (管理者)
- 管理者は API タスクの割り当てを作成できます。
- ステップ 3: API タスクの割り当ての一覧表示 (管理者)
- 管理者はすべての API タスクの割り当てをリストできます。
- ステップ 4: タスク実行 URL/トークンの生成
- URL とトークンを生成して、API タスクをデプロイします。
- ステップ 5: API タスクのリアルタイム エンドポイントの実行
- 生成された一意の URL とトークンで API タスクを実行します。