Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial
API platform
APIコレクション

APIレシピコレクション ​

このページは機械翻訳により提供されています。翻訳内容と英語版に相違がある場合は、英語版が優先されます。

APIレシピコレクションは、一連のエンドポイントです。各エンドポイントは単一のAPIレシピによって実行されます。 各APIレシピは1つのエンドポイントにマッピングされます。

レシピコレクションを使用すると、安全でカスタマイズ可能なAPIエンドポイントを通じてビジネスロジックを公開できます。 これらのエンドポイントは、チームメイトなどの内部ユーザーや、顧客またはサードパーティシステムなどの外部ユーザーが、Workatoアカウントを持っていない場合でも利用できます。

APIレシピコレクションを使用して、ワークスペース内の他のレシピがエンドポイントを呼び出してロジックを共有できるようにすることもできます。 関連するAPIレシピエンドポイントをコレクションにグループ化すると、アクセスと制御をより効果的に管理できます。

コレクションタイプ

プロキシ、レシピ、およびAIゲートウェイコレクションを比較するには、コレクションタイプを選択を参照してください。

前提条件 ​

APIレシピコレクションを作成する前に、以下を完了します。

  • プロジェクトを作成するか、既存のプロジェクトを選択します。
  • プロジェクト内にフォルダを作成し、1つ以上のAPIレシピを追加します。 このフォルダに追加した新しいAPIレシピは、自動的にコレクションに含まれます。 関連するAPIレシピをまとめてグループ化することをお勧めします。

APIレシピコレクションの作成 ​

APIレシピコレクションを作成するには、次の手順を完了します。

1

Workatoアカウントにサインインします。

2

プラットフォーム＞API platform＞APIコレクションに移動します。

3

+ 新しいコレクションを作成を選択します。

4

コレクションタイプを選択ドロップダウンメニューを使用して、APIレシピコレクションを選択します。

APIレシピコレクションを選択APIレシピコレクションを選択

5

設定タイプを選択ドロップダウンメニューを使用して、レシピコレクションに使用する設定を指定します。

  • 既存のレシピを使用：レシピフォルダを選択します。 Workatoは、フォルダ内の各APIレシピに対して1つのエンドポイントを作成します。

  • OpenAPI Specificationをインポート：JSONまたはUTF-8エンコードのYAML OpenAPI 3.0ファイルをアップロードするか、そのURLを入力します。 時刻値は引用符で囲みます。 たとえば、2024-07-18T10:00:00Zではなく、"2024-07-18T10:00:00Z"を使用します。

6

エンドポイントをカスタマイズに移動し、コレクションに追加する各エンドポイントのチェックボックスを選択します。

7

任意です。 エンドポイントの横にある詳細を編集を選択して、その設定を構成します。

1

エンドポイントのHTTPメソッドを選択します。

APIレシピコレクションエンドポイントをカスタマイズAPIレシピコレクションエンドポイントをカスタマイズ

2

エンドポイント名を入力します。

3

エンドポイントパスを定義します。 パスパラメータを含めることができます。 エンドポイントパスのガイドラインに従っていることを確認してください。

4

エンドポイントの説明を入力します。

5

タイムアウトをカスタマイズをオンにすると必須です。 リクエストタイムアウトフィールドで、リクエストの完了に許可する時間をカスタマイズします。 デフォルト値は30秒、最大値は240秒です。

6

スキーマ検証を有効にして、このエンドポイントに対して行われるすべてのリクエストを検証します。

7

リクエスト認可フィールドのFormulaを使用して、追加の認可ロジックを適用します。

8

レスポンスをキャッシュをオンにする場合は必須です。 Time-to-live期間フィールドで、レスポンスが更新または削除されるまでキャッシュに保存する期間を秒単位で指定します。 最大値は3600秒です。

8

コレクションの詳細を設定に移動し、以下を設定します。

1

APIコレクションのコレクション名を入力します。

2

バージョンを入力します。 1～10文字の一意の識別子を使用します。 同じ名前でバージョンが異なるコレクションは、別個のものとして扱われます。

3

APIコレクションの説明を入力します。

9

コレクションを作成を選択します。 Workatoはコレクションを追加し、作成されたエンドポイント数を表示します。

APIレシピコレクションを作成APIレシピコレクションを作成

10

APIコレクションを表示を選択します。

11

使用するエンドポイントを有効化するには、非アクティブボタンを切り替えます。

新しいエンドポイントはデフォルトで非アクティブ

すべての新しいエンドポイントは、デフォルトで非アクティブです。 他のレシピやアプリが呼び出せるようにするには、それぞれを有効化する必要があります。

コレクション内のAPIエンドポイントを有効化コレクション内のAPIエンドポイントを有効化

エンドポイントの有効化の詳細については、エンドポイントの有効化または無効化を参照してください。

12

特定のユーザーまたはアプリのアクセスを有効にするには、コレクションをクライアントのアクセルプロファイルに割り当てます。 新しいアクセスプロファイルの作成方法。

Last updated: