OpenAPIコネクターの設定
このガイドでは、WorkatoアカウントでOpenAPIコネクターをインストールし、設定する手順を説明します。
INFO
コネクターを完全にカスタマイズする場合は、OpenAPIコネクターを使用してカスタムコネクターを作成するガイドを参照してください。
要件
OpenAPIコネクションを設定するには、次が必要です。
コネクションの作成を許可するWorkatoの権限。
次の条件を満たすSwaggerファイル:
- OpenAPIv2またはv3の仕様に準拠していること
- 有効なJSONまたはYAMLである
注: 最適なエクスペリエンスを得るには、RESTful APIでコネクターを使用することをお勧めします。 詳細については、OpenAPI概要の制限事項セクションを参照してください。
ステップ1: コネクターをインストールする
最初のステップは、Workatoアカウントにコネクターをインストールすることです:
ステップ2: Workatoでコネクションを設定する
ステップ2.1: OpenAPIドキュメントを指定する
このステップでは、API定義を含むSwaggerファイルを指定します。
この方法は、ファイルがインターネット上で公開されているかどうかによって異なります:
ファイルが公開されている
Swaggerファイルが公開されている場合:
OpenAPIドキュメントソース：ドキュメントURLを選択します。
ドキュメントURL（フィールド）に、ファイルへのドキュメントURLを貼り付けます。
注: ファイルはレシピ設計時にのみダウンロードおよび解析されます。 レシピが実行されるとき、またはOpenAPIアクションが実行されるとき、ファイルはダウンロードされません。
ファイルが公開されていない
Swaggerファイルがホストされていない、または公開されていない場合は、ファイルをコピーしてWorkatoに貼り付けることができます:
OpenAPIドキュメントソース：コンテンツのダウンロードを選択します。
Document content（フィールド）に、ファイルの内容を貼り付けます。
ステップ2.2: 認証設定を定義する
次に、コネクションの認証方法を定義します。 サポートされている認証方法について詳しくは、OpenAPI概要ガイドを参照してください。
使用している方法を、Authentication Method（メニュー）から選択します。
ステップ2.3: サーバーURLとテストURLを定義する
次に、コネクターのサーバーURLとテストURLを定義します:
サーバーURL：アプリケーションのターゲットホストまたはサービスのURLを、
https://を含めて入力します。 これは、コネクターによって送信されるリクエストのベースURLです。 例:https://api.example.comAPI定義の相対エンドポイントパスがこのURLに追加され、完全なエンドポイントURLが構築されます。
Test Request URL：Workatoがコネクションの検証に使用できるAPIエンドポイントの相対パスを入力します。 このパスはServer URLに追加され、テスト用の完全なエンドポイントURLが構築されます。 例:
/user/profileAPIが
2XXステータスコードで応答すると、コネクションは成功します。
例：サーバーURL：https://api.example.com、Test Request URL：/users/profileの場合、完全なリクエストURLはhttps://api.example.com/users/profileです。
ステップ2.4: インターフェイスをカスタマイズする
OpenAPIコネクターは、指定されたSwaggerファイルの内容に基づいてユーザーインターフェイスを自動的に生成します。 ユーザーエクスペリエンスを向上させるために、次の要素をカスタマイズできます:
- オブジェクト名
- オブジェクトヒント
- フィールド名
- フィールドヒント
- 外部ドキュメントへのリンク
- APIオペレーションのグループ化
- 無視するフィールド
詳細と例については、OpenAPIユーザーインターフェースのカスタマイズガイドを確認してください。
ステップ3: コネクションをテストする
コネクションの設定が完了したら、Connectをクリックしてコネクションを保存し、テストします。
Last updated: