セッションAPI一覧

セッションの開始 session.open_session

セッションを開始し、ID・トークンを取得する場合のJSON-RPCのリクエスト例は下記の通りです。

{
  "jsonrpc": "2.0",
  "method": "session.open_session",
  "params": {
    "expires_in": null,
  },
  "id": "jsonrpc_id"
}

params には以下のパラメータを指定します。

パラメータ名	データ型	内容	既定値
expires_in	int	トークン（セッション）の有効期間	30日

レスポンスの形式は以下の通りです。

{
  "result": {
    "access_token": "00890640-ec03-4663-82ce-456ea993807d",
    "expires_in": 2592000
  },
  "id": "jsonrpc_id",
  "jsonrpc": "2.0"
}

トークンの有効チェック session.verify_session_token

トークンが有効かどうか判定する場合のJSON-RPCのリクエスト例は下記の通りです。

{
  "jsonrpc": "2.0",
  "method": "session.verify_session_token",
  "params": {"token": "00890640-ec03-4663-82ce-456ea993807d"},
  "id": "jsonrpc_id"
}

params には以下のパラメータを指定します。

パラメータ名	データ型	内容	既定値
token	string	session.open_sessionのレスポンスで返却されたトークン	必須

レスポンスの形式は以下の通りです。

{
  "result": {
    "active": true
  },
  "id": "jsonrpc_id",
  "jsonrpc": "2.0"
}

• active: トークンが有効か判定結果（true or false）を返します。

セッションの終了 session.close_session

セッションを終了させる場合のJSON-RPCのリクエスト例は下記の通りです。

{
  "jsonrpc": "2.0",
  "method": "session.close_session",
  "params": {"token": "00890640-ec03-4663-82ce-456ea993807d"},
  "id": "jsonrpc_id"
}

params には以下のパラメータを指定します。

パラメータ名	データ型	内容	既定値
token	string	session.open_sessionのレスポンスで返却されたトークン	必須

レスポンスの形式は以下の通りです。

{
  "result": true,
  "id": "jsonrpc_id",
  "jsonrpc": "2.0"
}

• result: リクエストが正しい場合、常に true が返ります。（発行されていないトークンを渡しても、トークンを無効化しても、最終的に無効化されている状態なので true という考えです）