4. 共通定義

4.1. HTTP ヘッダ

4.1.1. 管理者セッショントークン

以下ヘッダは、管理者セッショントークンを送信するために使用する。

• X-Developer-Token : 管理者セッショントークン

管理者セッショントークンは、ログイン API 発行時にサーバからクライアントに発行され、ログアウト時に破棄される。 API 発行時の X-Developer-Token の送信ルールは以下の通りである。

• クライアントが管理者セッショントークンを保持している場合、X-Developer-Token を常時送信する。
• クライアントが管理者セッショントークンを保持していない場合、X-Developer-Token は送信しない。

なお、以下 API の説明で X-Developer-Token が「必須」となっている場合、セッショントークンを送信せずにAPI を呼び出すとエラーを返却する (X-Developer-Token を付けずに API を呼び出してはならない、という意味ではない)。 また、X-Developer-Token が記載されていない場合、サーバは X-Developer-Token を参照しない (送信してはならない、という意味ではない)

その他の共通定義全般については、REST API リファレンス 本編 を参照のこと。