APIレシピFAQ ​

2021年12月3日に、APIエンドポイントとしてオートメーションを作成およびデプロイするための新しい専用レシピタイプ、APIレシピをリリースします。 APIレシピには、OpenAPI Specificationの全機能を利用して構築できるようにする新機能が含まれています。これには次が含まれます:

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

このリリースにより、WorkatoエコシステムにおいてAPIが第一級の存在であることが確認され、自動ドキュメント化の改善や、有効なOpenAPI specificationからAPIコレクションを自動生成する機能など、今後のさらなる改善に向けた基盤が整います。

変更内容 ​

この新しいレシピタイプに対応するために、Workatoで変更される内容は次のとおりです：

• レシピウィザードの開始点
• APIコレクションの作成
• APIエンドポイントの編集

レシピウィザードの開始点 ​

Build an API endpointレシピの開始点は引き続き利用できますが、これを選択すると、呼び出し可能なレシピではなく、新しいAPIレシピタイプのレシピが作成されます。

注：2021年12月3日以降、呼び出し可能なレシピをAPIエンドポイントとして作成することはできなくなります。 既存の呼び出し可能なレシピは引き続き実行されますが、サポート対象外になります。

APIコレクションの作成 ​

新しいAPIコレクションを作成する際、レシピの取得元となるフォルダを選択するよう求められます。

以前は、Workatoが選択したフォルダ内の呼び出し可能なレシピを取得し、対応するAPIエンドポイントを作成していました。 2021年12月3日以降、Workatoは選択したフォルダ内の呼び出し可能なレシピおよびAPIレシピごとにエンドポイントを作成します。

注：2つのレシピタイプに視覚的な違いはありません：

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

以前は、APIエンドポイントを編集する際、任意の呼び出し可能なレシピを選択してエンドポイントに割り当てることができました。

現在は、任意のAPIレシピまたは呼び出し可能なレシピから選択できます。 レシピは名前で表示され、2つのタイプに視覚的な違いはありません：

FAQ ​

• 既存の呼び出し可能なレシピをAPIレシピに置き換える必要がありますか
• 呼び出し可能なレシピを新しいタイプに変換する方法はありますか
• APIレシピはレシピベースのプランで課金対象ですか
• 同じ呼び出し可能なレシピをAPIエンドポイントおよび再利用可能なコンポーネントとして使用しています。 これは引き続き機能しますか
• 以前と同様に、APIエンドポイント用の呼び出し可能なレシピを作成できますか
• 詳細はどこで確認できますか

既存の呼び出し可能なレシピをAPIレシピに置き換える必要がありますか ​

いいえ。 既存のレシピは引き続き機能します。 非標準のレスポンスコードのサポートなど、新たにサポートされた機能を利用したい場合は、既存の呼び出し可能なレシピをAPIレシピに置き換えることを検討できます。

呼び出し可能なレシピを新しいタイプに変換する方法はありますか ​

現在はありません。 ただし、呼び出し可能なレシピはこれまでどおり機能し続けるため、レシピを変換する必要はありません。

APIレシピはレシピベースのプランで課金対象ですか ​

はい。APIレシピは課金対象のレシピです。

同じ呼び出し可能なレシピをAPIエンドポイントおよび再利用可能なコンポーネントとして使用しています。 これは引き続き機能しますか ​

はい。 既存の呼び出し可能なレシピは、APIエンドポイントとしても、他のWorkatoレシピから呼び出すためにも引き続き使用できます。 ただし、実際にはこれはかなりまれです。

APIレシピとレシピ関数でこのユースケースをサポートするには、2つのレシピを作成する必要があります。 モジュール性を維持するために、ロジックの大部分をレシピ関数内に保持し、APIレシピから呼び出すことができます。

以前と同様に、APIエンドポイント用の呼び出し可能なレシピを作成できますか ​

いいえ。 呼び出し可能なレシピは段階的に廃止されます。

これまでは、呼び出し可能なレシピタイプと呼び出し可能なレシピ by Workatoアプリが、APIエンドポイントの作成などの目的で使用されてきました。 専用のAPIレシピタイプのリリースに伴い、呼び出し可能なレシピの使用を段階的に廃止していきます。

2021年12月3日以降、新しい呼び出し可能なレシピを作成することはできなくなります。 新しいレシピを構築する際にBuild an API Endpointを選択すると、代わりにAPIレシピが作成されます。

これは破壊的変更ではありません。 既存のすべての呼び出し可能なレシピは引き続き機能します。

詳細はどこで確認できますか ​

詳細については、APIレシピドキュメントを確認してください。

レシピ関数の詳細については、レシピ関数FAQを確認してください。