APIレシピエンドポイント ​

APIレシピは、APIエンドポイントとして呼び出すことができるレシピの一種です。 これらのエンドポイントは他のレシピで使用したり、外部ユーザーと共有したりできます。 たとえば、サプライヤーに在庫状況を提供するAPIエンドポイントを作成できます。

APIレシピ ​

APIレシピでは、APIのレシピロジック、リクエストスキーマ、およびレスポンススキーマを定義します。 APIレシピの作成ガイドを参照して、APIレシピを構成してください。

APIレシピ

トリガーとアクション ​

API platform by Workatoコネクターには、次のリソースが含まれています：

• New APIリクエストトリガーは、リクエストとレスポンスの構造を定義し、APIリクエストを受信するとジョブを作成します。
• Response to APIリクエストアクションは、現在のジョブを終了し、トリガーで定義されたレスポンスの1つを送信します。

APIレシピを正常に完了するには、両方のステップが必要です。 レシピの開始点としてBuild an APIエンドポイントを選択すると、WorkatoはNew APIリクエストトリガーを含むレシピを自動的に作成します。

レシピエンドポイント ​

レシピエンドポイントでは、APIのHTTPメソッド、エンドポイント名、エンドポイントパス、リクエストタイムアウト、スキーマ検証、およびレスポンスキャッシュを定義します。 新しいAPIレシピエンドポイントの構成ガイドを参照して、レシピエンドポイントを構成してください。

レシピエンドポイント

APIコレクション ​

APIコレクションは、APIレシピエンドポイントをグループ化して、ユーザーとアプリケーションのアクセス制御を効率化します。 APIコレクションガイドを参照して、APIコレクションを構成してください。

APIコレクション内のエンドポイント

APIパフォーマンス ​

APIパフォーマンスは、次の方法で改善できます:

• ログを無効化: レシピの設定 > データリテンションタブに移動し、ジョブデータリテンション設定を構成してログの作成を無効にします。 詳細については、レシピのデータリテンションの定義ガイドを参照してください。

• APIキャッシュを有効化: エンドポイントの設定タブに移動し、Cache responseを有効にしてAPIキャッシュを有効にします。 詳細については、APIエンドポイントキャッシュガイドを参照してください。