ヘッダー

Web APIリクエストの一部として送信されるようHTTPヘッダーを構成します。ヘッダーは、API全体および個々のリクエストメソッドに対して定義できます。

• 共通 - 共通ヘッダーは、API定義内のアクションによって生成されるすべてのリクエストで送信されます。
• リクエスト固有 - 関連するアクションのリクエストでのみ送信されるヘッダーです。

ヘッダーは名前と必要な値を入力して定義されます。値にはAPIが呼び出されたときに動的に値を追加するパラメーターを含めることができます。

同じ名前を共通ヘッダーとリクエスト固有ヘッダーに使用できます。この場合、API定義で両方に値が設定されていると、APIが呼び出されたときにリクエスト固有ヘッダーの値が使用されます。

この例は、API定義から作成されたAPIリクエストを示しています。

• リクエストには、共通ヘッダーとリクエスト固有ヘッダーの両方が含まれています。
• ［コンテンツタイプ］ヘッダーには、APIが呼び出されるときにリクエスト固有ヘッダーの値で上書きされる共通ヘッダーに設定された値があります。
• ［から］ヘッダーには、［メールアドレス］パラメーターで設定した値が入力されます。