APIコレクション ​

APIコレクションは、共通のアクセスパターンを持つAPIエンドポイントで構成されるため、まとめて管理できます。 たとえば、営業チームが使用するレシピから呼び出されるSalesforceエンドポイントのセットは、APIコレクションにまとめる必要があります。

APIコレクションページにアクセスするには、プラットフォーム > API platform > APIコレクションに移動します。 APIコレクションページには、ワークスペース内のすべてのAPIコレクションが表示されます。

コレクションには、APIプロキシエンドポイント、APIレシピエンドポイント、またはAIゲートウェイエンドポイントのいずれかを含めることができます。

APIコレクションページ

コレクションタイプ ​

APIコレクションには3つのタイプがあります。

• APIプロキシコレクション: 既存のAPIバックエンドに受信リクエストを転送します。 最小限のレイテンシーで、大量かつ低コストのジョブ向けに最適化されています。
• APIレシピコレクション: APIレシピからカスタムエンドポイントを構築します。 データの取得および処理に関する完全な柔軟性を備え、高価値のジョブ向けに最適化されています。
• AIゲートウェイコレクション: LLM、GPT、またはその他のAIアプリケーションにエンドポイントを公開し、ユーザーに代わってアクションを実行できるようにします。

選択するコレクションのタイプは、ユースケースによって異なります。 次のデシジョンツリーを使用して、要件に合ったコレクションタイプを決定します:

APIプロキシコレクション ​

独自のバックエンドを持ち込む予定の場合は、APIプロキシコレクションを選択します。 プロキシエンドポイントが受信リクエストを受け取ると、Workatoはそのリクエストを既存のAPIバックエンドに転送します。

このシナリオでは、次の理由からAPIプロキシコレクションが最適です:

• APIプロキシコレクションは、大量かつ低コストのジョブ向けに最適化されています。
• プロキシジョブは最小限のレイテンシーで実行されます。
• プロキシリクエストは同時実行制限の対象ではありません。
• APIプロキシコレクションでは、主な機能がリクエストの転送であるため、カスタマイズオプションは制限されます。

詳細については、APIプロキシコレクションガイドを参照してください。

APIレシピコレクション ​

独自のバックエンドを構築する予定の場合は、APIレシピコレクションを選択します。 コレクション内の各エンドポイントは、他のソースからデータを取得して処理するロジックを含むAPIレシピにマッピングされます。 たとえば、レシピでSalesforce APIを使用して特定の名前に一致する商談を検索し、検索結果に一致する商談がない場合は商談を作成できます。

このシナリオでは、次の理由からAPIレシピコレクションが最適です:

• APIレシピコレクションは、高価値のジョブ向けに最適化されています。
• APIレシピジョブは同時実行制限の対象です。
• APIレシピコレクションは、データの取得および処理方法を高度にカスタマイズできる柔軟性を提供します。

詳細については、APIレシピコレクションガイドを参照してください。

AIゲートウェイコレクション ​

LLM、GPT、またはその他のAIアプリケーションにエンドポイントを公開する予定の場合は、AIゲートウェイコレクションを選択します。 この公開により、AIアプリケーションはユーザーに代わってアクションを実行できます。

このシナリオでは、次の理由からAIゲートウェイコレクションが最適です:

• AIゲートウェイコレクションでは、リクエストを安全に保つために、WorkatoとAIエージェントの間の認可メカニズムを指定できます。
• AIゲートウェイコレクションを使用すると、WorkatoからOpenAPI Specification（OAS）をアップロードして、AIエージェントの追加処理を防ぐことができます。

詳細については、AIゲートウェイコレクションガイドを参照してください。

Postmanに同期 ​

APIコレクションが正常にデプロイされてライブになった後、元のクライアント以外にもAPIコレクションを利用可能にできます。 APIコレクションをPostmanワークスペースに同期して、Postmanの内部および外部ポータルを通じて可視性を高め、導入を促進します。

詳細については、Postmanへの同期を参照してください。