Product UpdatesStatus PageAutomation Institute
日本語

# API レシピに関するよくある質問 (FAQ)

2021年12月3日 、 API レシピ がリリースされます。これは、オートメーションを API エンドポイントとして作成および導入するために専用に用意された、新しいタイプのレシピです。API レシピの新機能により、以下をはじめとする OpenAPI 仕様をフル活用したエンドポイントの作成が可能になります。

  • カスタムリクエストとレスポンスヘッダー
  • 複数のレスポンスとすべての HTTP レスポンスコードをサポート
  • レスポンス送信後にジョブを自動停止

このリリースにより、API は Workato エコシステムにおける「第一級市民」としてしての地位を確立し、今後のさらなる改善 (たとえば、ドキュメントの自動生成機能の強化や、有効なあらゆる OpenAPI 仕様に基づいた API コレクションの自動生成など) に向けた基盤を築きました。

# 変更点

この新しいタイプのレシピに対応するために、Workato に次のような変更が加えられました。

# レシピウィザードのスタートポイント

レシピのスタートポイントとして [Build an API endpoint] は引き続き使用できますが、これを選択すると呼び出し可能レシピではなく、新しい API レシピタイプのレシピが作成されるようになりました。

注 : 2021年12月3日を過ぎると、コーラブルレシピを API エンドポイントとして作成できなくなります。ただし、既存のコーラブルレシピは、これからもずっと機能し続けます。

# API コレクションの作成

新しい API コレクションを作成する際、レシピの提供元フォルダーを選択するためのプロンプトが表示されます。

以前は、ここで選択されたフォルダー内から Workato がコーラブルレシピを見つけて、それに対応する API エンドポイントを作成していました。2021年12月3日以降は、各コーラブルレシピと API レシピのエンドポイントが、選択されたフォルダー内に作成されます。

注 : 2つのタイプのレシピに、見た目の違いはありません。

レシピビルダー内のレシピファンクションアプリケーション

# API エンドポイントの編集

API エンドポイントを編集する際、これまではエンドポイントに割り当てるコーラブルレシピを任意に選択できました。

今後は、任意の API レシピまたはコーラブルレシピを選択できます。レシピは名前で表示され、2つのタイプに見た目の違いはありません。

レシピビルダー内のレシピファンクションアプリケーション

# よくある質問 (FAQ)

# 既存のコーラブルレシピを API レシピに置き換える必要がありますか。

いいえ。既存のレシピは、これからもずっと機能し続けます。ただし、非標準のレスポンスコードのサポートなど、新たにサポートされる機能を活用するには、既存のコーラブルレシピを API レシピに置き換えることをお勧めします。

# コーラブルレシピを新しいタイプに変換する方法はありますか。

現在のところ、ありません。といっても、コーラブルレシピはこれまでと同様に機能し続けるため、変換する必要はありません。

# API レシピはレシピベースのプランで請求可能ですか。

はい。API レシピは請求可能レシピです。

# 同じコーラブルレシピを API エンドポイントとしても、再利用可能コンポーネントとしても使用しています。今後も正常に機能しますか。

はい。既存のコーラブルレシピはこれからも、API エンドポイントとして使用することも、他の Workato レシピから呼び出して使用することもできます。ただし実際的には、このようなケースは極めてまれです。

API レシピとレシピファンクションを使用する、このようなユースケースに対応するには、2つのレシピを作成する必要があるでしょう。モジュール性を維持するため、内部ロジックの大部分はレシピファンクション内に保持しておき、それを API レシピから呼び出すとよいでしょう。

# 以前のように API エンドポイント用にコーラブルレシピを作成できますか。

いいえ。コーラブルレシピは段階的に廃止される予定です。

これまで、API エンドポイントの作成やその他の目的には、コーラブルレシピタイプと Workato によるコーラブルレシピアプリケーションが使われてきました。今回の専用の API レシピタイプのリリースをもって、Workato ではコーラブルレシピの使用を段階的に終了していく予定です。

2021年12月3日以降、コーラブルレシピを新たに作成することはできなくなります。新しいレシピを作成する際に、 [Build an API Endpoint] を選択すると、コーラブルレシピではなく API レシピが作成されます。

この変更により互換性が失われることはありません。 既存のコーラブルレシピはすべて、これからもずっと機能し続けます。

# 詳細については、どこを見ればよいですか。

API レシピに関するドキュメントをご覧ください。

レシピファンクションの詳細は、レシピファンクションに関するよくある質問 (FAQ) を参照してください。


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

On this page