新しいAPIレシピエンドポイントの設定
新しいAPIレシピエンドポイントを設定するには、次の手順を完了します:
前提条件
新しいAPIレシピエンドポイントを作成する前に、次の前提条件を完了していることを確認してください:
APIレシピとエンドポイントの整理
関連するエンドポイントを持つAPIレシピは、ワークスペース内の同じAPIコレクションおよびフォルダに整理することをお勧めします。 たとえば、営業チームのレシピで使用するSalesforceエンドポイントを1つのAPIコレクションにグループ化します。
APIエンドポイントURLの詳細を確認します。
レシピエンドポイントの作成
レシピベースのエンドポイントを作成するには、次の手順を完了します:
プラットフォーム＞API platform＞APIコレクションに移動し、新しいエンドポイントを作成するAPIレシピコレクションを選択します。
+ 新しいエンドポイントを選択します。
+ 新しいエンドポイントを選択
以下のフィールドに入力します:
レシピ
このエンドポイントに関連付けるAPIレシピを選択します。 ドロップダウンメニューには、アクセス可能なAPIレシピが表示されます。
HTTPメソッド
エンドポイントで使用するHTTPメソッドを選択します。
エンドポイント名
エンドポイントのわかりやすい名前を入力します。
エンドポイントパス
エンドポイントパスを入力します。これにはパスパラメータを含めることができます。 エンドポイントパスがエンドポイントパスのガイドラインに従っていることを確認します。
エンドポイントの説明
エンドポイントの説明を入力します。
リクエストタイムアウト
リクエストタイムアウト期間を入力します: 30秒（デフォルト）、240秒（最大）。
スキーマ検証
任意です。 スキーマ検証を有効にします。
レスポンスをキャッシュ
レスポンスをキャッシュトグルをクリックしてキャッシュを有効にします。 このオプションはGETメソッドでのみ使用できます。
Time-to-live期間
必須。 レスポンスが更新または削除されるまでキャッシュに保存される期間を秒単位で入力します。 デフォルト値は600秒、最大値は3600秒です。
キャッシュキーパラメータ
任意です。 必要に応じて、キャッシュキーに含める追加パラメータを定義します。 キャッシュキーは常にエンドポイントURLで始まります。 詳細については、APIエンドポイントのキャッシュを参照してください。
レシピベースのエンドポイントを追加
エンドポイントを追加を選択します。 新しいレシピエンドポイントがAPIコレクションページに表示されます。
エンドポイントの横にある•••（省略記号）をクリックして、名前の変更、有効化、または削除を行います。
スキーマ検証
スキーマ検証はエンドポイントレベルで動作し、APIレシピエンドポイントの検証を適用できます。 受信APIリクエストが事前定義されたデータ形式と制約に準拠することを要求することで、データ整合性の確保に役立ちます。 必須フィールドとフィールドタイプを検証することで、無効または空のリクエストを防止し、セキュリティ、データ精度、システム信頼性を向上できます。
適用されるスキーマルール
スキーマ検証は、エンドポイントごとに各リクエストに次のチェックを適用します:
- フィールドの存在: すべての必須フィールドが含まれていることを確認します。 必須フィールドが欠落している場合、リクエストは拒否されます。
- フィールドタイプ: 各フィールドが指定されたデータタイプと一致することを確認します。 フィールドのデータタイプが正しくない場合、リクエストは拒否されます。
リクエストが検証に失敗すると、サーバーはエラーの詳細を含む400 Bad Requestエラーで応答します。
ペイロードサイズの制限
スキーマ検証は、ペイロードサイズが1MB以下のリクエストにのみ適用されます。
スキーマ検証の有効化
APIレシピエンドポイントのスキーマ検証を有効にするには、次の手順を完了します:
プラットフォーム＞API platform＞APIコレクションに移動します。
APIコレクションを選択します。
APIレシピエンドポイントを選択します。
エンドポイントの設定タブを開きます。
スキーマ検証トグルを有効にします。
レシピエンドポイントの表示
APIコレクションの概要からAPIエンドポイントを選択して、その詳細情報にアクセスします。 この情報は、コレクションの概要からOpenAPI 2.0仕様でダウンロードすることもできます。
レシピベースのエンドポイントには、次のタブが含まれます:
APIレシピを表示
レシピベースのエンドポイントのSettingsタブを表示Last updated: