Product UpdatesStatus PageAutomation Institute
日本語
コネクター
ユニバーサルコネクター
OpenAPI

# OpenAPI コネクターの設定

このガイドでは、Workato アカウントで OpenAPI コネクターをインストールして設定するための手順を説明します。

NOTE

コネクターを完全にカスタマイズする場合は、「OpenAPI コネクターを使用したカスタムコネクターの作成」ガイドを参照してください。

# 要件

OpenAPI コネクションを設定するには、以下が必要です。

# ステップ1 : コネクターをインストールする

最初のステップは、次の手順に従い、Workato アカウントでコネクターをインストールすることです。

1

コミュニティーライブラリーでコネクター (opens new window)を開きます。

2

[Install connector] をクリックします。

3

[Release latest version] をクリックします。

# ステップ2 : Workato でコネクションを設定する

# ステップ2.1 : OpenAPI ドキュメントを指定する

このステップでは、API 定義を含んでいる Swagger ファイルを指定します。

その方法は、ファイルがインターネット上で公開されているかどうかによって異なります。

ファイルが公開されている

Swagger ファイルが公開されている場合は以下のようにしてください。

1

[OpenAPI document source] として、 [Document URL] を選択します。

2

[Document URL] フィールドに、Swagger ファイルへのドキュメント URL を貼り付けます。

注 : ファイルはレシピの設計時にのみダウンロードされて解析されます。レシピの実行時や OpenAPI アクションの実行時には、ファイルがダウンロードされません。

ファイルが公開されていない

Swagger ファイルがホスティングされていない、または公開されていない場合は、ファイルをコピーして Workato に貼り付けます。

1

[OpenAPI document source] として、 [Download content] を選択します。

2

[Document content] フィールドに、ファイルの内容を貼り付けます。

# ステップ2.2 : 認証設定を定義する

次に、接続のための認証方法を定義します。サポートされている認証方法の詳細については、「OpenAPI の概要」ガイドを参照してください。

[Authentication Method] メニューから、使用する方法を選択します。

# ステップ2.3 : サーバー URL とテスト用 URL を定義する

次に、コネクターのためのサーバー URL とテスト用 URL を定義します。

  • Server URL : アプリケーションのターゲットホストまたはサービスに対する URL を入力します。https:// も含めてください。これは、コネクターが送信するリクエストのベース URL になります。例 : https://api.example.com

    API 定義に含まれる相対エンドポイントパスがこの URL に付加され、完全なエンドポイント URL が作成されます。

  • Test Request URL : Workato が接続を検証するために使用できる API エンドポイントの相対パスを入力します。このパスが [Server URL] に付加され、テスト用の完全なエンドポイント URL が作成されます。例 : /user/profile

    API がステータスコード 2XX を返すと、接続は成功です。

例 : [Server URL] に https://api.example.com、 [Test Request URL] に /users/profile と入力すると、https://api.example.com/users/profile という完全なリクエスト URL が作成されます。

# ステップ2.4 : インターフェイスをカスタマイズする

OpenAPI コネクターは、指定された Swagger ファイルの内容に基づいて、ユーザーインターフェイスを自動的に生成します。ユーザーエクスペリエンスを向上させるために、以下の要素をカスタマイズできます。

  • オブジェクト名
  • オブジェクトヒント
  • 項目名
  • 項目ヒント
  • 外部ドキュメントへのリンク
  • API 操作の分類
  • 無視する項目

詳細と例については、「OpenAPI ユーザーインターフェイスのカスタマイズ」ガイドを参照してください。

# ステップ3 : コネクションをテストする

コネクションの設定が完了したら、 [Connect] をクリックして、コネクションを保存してテストします。

← 認証
カスタムコネクターの作成 →


Last updated: 2023/8/31 1:07:14

On this page