# API レシピ
新しいレシピエクスペリエンス
API エンドポイント機能のコーラブルレシピは、API レシピに置き換えられました。詳細については、よくある質問 (FAQ) をご覧ください。
API レシピとは、REST API エンドポイントの作成に使用できるレシピの一種です。API プラットフォーム機能を使用することで、これらのエンドポイントを外部ユーザーに公開したり、他のレシピで利用したりすることができます。
API レシピを使用すると、パートナーや他のアカウントとのデータの共有が可能になります。たとえば、サプライヤに在庫の状況を提供する REST API を作成できます。
このガイドでは、次の項目について説明します。
# 要件
API レシピを使用するには、API プラットフォーム機能にアクセスする必要があります。このオプションが [Tools] メニューに表示されない場合は、カスタマーサクセスマネージャーまでお問い合わせください。
# トリガーとアクション
レシピ新規作成時に [Build an API endpoint] を使用すると、Workato により以下のステップを伴うレシピが自動的に作成されます。
- 新規 API リクエストトリガー、および
- API リクエストに対するレスポンスアクション
その他のアクションの追加も可能ですが、API レシピを適切に作成するには、これら2つのステップが必須です。
# API レシピの作成
それでは API レシピを作成してみましょう。API レシピのウォークスルーから始めてください。
# API のパフォーマンス
最適な API のパフォーマンスを実現したい場合は、 [Jobs data retention] レシピ設定でログの作成を無効にすることで、API レシピの遅延を低減できます。
詳細については、「レシピのデータ保持の定義」ガイドを参照してください。
Last updated: 2023/8/31 1:07:14