API platform ​

WorkatoのAPI platformは、エンタープライズグレードの機能を備えており、APIゲートウェイ、ガバナンス、設計、セキュリティ、監視機能など、主要なAPI管理機能を網羅しています。

API platformでは、APIプロキシを作成できます。APIプロキシはトラフィックを内部APIに安全に転送します。

API platformでは、レシピ機能をAPIエンドポイントとして公開するAPIレシピも作成できます。 これにより、パートナーとデータを共有したり、他のレシピで機能を使用したりできます。

エンドポイントがレシピベースかプロキシベースかに関係なく、エンドポイントのグループからAPIコレクションを作成できます。

API公開者は、エンドポイントへのアクセスを制御し、リクエストを監視し、利用状況に制限を設定できます。

主な機能 ​

API platformには、次の主要な機能があります。

APIゲートウェイ ​

APIゲートウェイは、APIを管理するための堅牢な機能を提供し、高度なセキュリティ、効率的なルーティング、効果的なメディエーションを統合して、最適なパフォーマンスと信頼性を確保します。 詳細はこちら。

APIガバナンス ​

効果的なガバナンスにより、APIが安全でコンプライアンスに準拠し、ベストプラクティスに従って管理されます。 これには、活動監査、バージョニング、ライフサイクル管理が含まれます。 詳細なアクセス制御とポリシーを実装して、利用状況とアクセスを管理します。 APIアクセスポリシーを使用すると、レート制限とクォータ管理を適用できます。 これらのポリシーにより、単一のクライアントによる過剰利用を防ぎ、APIの効率的かつ安全な使用を確保できます。

詳細はこちら。

API設計 ​

Workatoは、APIの作成、デプロイメント、管理を簡素化する直感的な機能により、APIDevelopmentを加速します。 レシピエンドポイントとプロキシエンドポイントを使用すると、ローコード/ノーコードのアプローチでWorkato上に独自のAPIを構築したり、既存のAPIを安全に公開したりできます。 APIの設計とドキュメント化のためのWorkatoネイティブツールを使用して、APIのエンドポイント、メソッド、データ構造を定義します。 詳細はこちら。

API監視 ​

包括的な監視および分析ツールで、APIの利用状況とパフォーマンスを追跡および分析します。 API platformダッシュボードでは、エンドポイントとAPIコレクションのリアルタイムデータを可視化できます。 これには応答時間、エラーメッセージ、トラフィックパターンなどのメトリックが含まれ、APIのプロアクティブな管理と最適化が可能になります。 詳細はこちら。

APIセキュリティ ​

Workatoのエンタープライズグレードのセキュリティ対策により、APIを安全に公開します。 WorkatoのAPIゲートウェイは、APIへの安全なアクセスを確保するためにさまざまな認証方法をサポートしています。 OAuth 2.0、JWTトークン、OpenID Connectを使用して、APIへのアクセス方法と使用方法に柔軟性とセキュリティを提供します。 詳細はこちら。

主な概念と機能 ​

このセクションでは、API platformの主要な概念と機能について説明します。

APIコレクション ​

APIコレクションは、一緒に管理できるエンドポイントのセットです。 これらのエンドポイントは、APIレシピベースまたはAPIプロキシベースにできます。 詳細はこちら。

アクセスポリシー ​

アクセスポリシーを使用して、APIの利用状況に制限を設定できます。 1つのポリシーを1つ以上のアクセスプロファイルに関連付けることができます。 詳細はこちら。

アクセスプロファイル ​

1つのクライアントは1つ以上のアクセスプロファイルを持つことができます。 アクセスプロファイルは、クライアントがアクセスできる1つ以上のAPIコレクションを指定し、任意でアクセスポリシーに関連付けられます。 詳細はこちら。

APIプロキシ ​

APIプロキシは、クライアント向けAPIを内部APIから分離するゲートウェイです。 API platformが提供する管理機能を活用しながら、内部APIをエンドポイントとして安全に公開できます。 詳細はこちら。

APIレシピ ​

APIレシピは、APIエンドポイントの作成に使用できるレシピの一種です。 API platform機能を使用すると、これらのエンドポイントを外部ユーザーに公開したり、他のレシピで使用したりできます。 詳細はこちら。

APIトークン ​

APIトークンは、アクセスプロファイル内のすべてのAPIコレクションへのアクセスを許可します。 技術的には、APIトークンはapi-tokenという名前でHTTPヘッダーに渡される文字列です。 詳細はこちら。

クライアント ​

クライアントは、1つ以上のAPIコレクションへのアクセスを許可できるユーザーです。 詳細はこちら。

同時実行 ​

同時実行とは、特定の時点で同時に処理できるリクエスト数を指します。

同時実行制限 ​

同時実行制限は、ワークスペースが同時に処理できるリクエストの最大数です。

ダッシュボード ​

APIコレクションとエンドポイントのリアルタイムデータを可視化するためのカスタマイズ可能なツール。 詳細はこちら。

エンドポイント ​

エンドポイントは、呼び出し可能な単一のRESTインターフェースです。 関連付けられた公開URLがあります。

APIレシピベースのエンドポイントでは、URLへの呼び出しにより、新規APIリクエストトリガーを持つレシピが開始されます。 詳細はこちら。

APIプロキシベースのエンドポイントでは、エンドポイントURLへの呼び出しがHTTPコネクション内のターゲットURLに転送されます。

ライブラリ ​

ライブラリは、組織内の他のユーザーが検出できるAPIのカタログです。 詳細はこちら。

ピーク時の同時APIリクエスト ​

これは、ワークスペース全体で同時に処理されたピークAPIリクエストのサマリーを表します。

キュー ​

同時実行制限に達すると、システムはリクエストを自動的にキューに配置します。 他の同時リクエストが完了すると、これらのキュー内のリクエストを処理します。

キューサイズ ​

キューサイズは、同時実行制限に達したときにキューに保持できるリクエストの最大数を表します。 キューが最大容量に達すると、システムは新しい受信リクエストを拒否します。

レシピレベルの同時実行 ​

レシピレベルの同時実行は、個別のAPIレシピに特定の同時実行制限を設定できる機能です。 これにより、選択したエンドポイントを優先したり、高トラフィックのエンドポイントを調整したりできます。