# APIポータル

APIポータルでは、管理者がAPIドキュメントを公開し、使用を促進し、アクセスを管理することができます。

Workato APIプラットフォームのクライアントごとに専用のセキュアなAPIポータルが提供されます。APIクライアントを作成すると、Workatoは自動的にポータルをプロビジョニングします。このポータルでは、クライアントはAPIドキュメントを閲覧し、各APIコレクションのOpenAPI仕様をダウンロードし、エンドポイントをテストすることができます。

# APIコレクションを閲覧する

APIポータルでは、クライアントはアクセスできるAPIコレクションのリストを閲覧することができます。このリストは動的に更新されるため、新しく付与されたAPIコレクションはリロード時に表示されます。

APIコレクションを閲覧する APIコレクションを閲覧する

# OpenAPI仕様をダウンロードする

APIコレクションをクリックすると、このコレクション内のエンドポイントのリストが表示されます。このページでは、クライアントはOpenAPI仕様書をダウンロードすることができます。この機械可読なドキュメントは自動生成され、外部アプリケーションで使用するためのものです。

OpenAPI仕様をダウンロードする OpenAPI仕様をダウンロードする

# エンドポイントをテストする

クライアントは有効なアクセストークンを提供し、ポータル内で各エンドポイントを直接テストすることができます。テストページには、このエンドポイントに指定された各パラメータの入力フィールドがあります。

APIをテストする APIをテストする


Last updated: 2024/2/13 16:59:53