コンテンツにスキップ

session.open_session

新規のセッションを開始します。

パラメータ

  • expires_in: integer -- セッションの有効期間 (秒)。 本項目は省略可能です。 省略された場合の有効期間は 30 日 (2,592,000 秒) になります。

戻り値

  • access_token: string -- セッショントークン。 セッションが有効な間は、セッショントークンを指定して各種 API を利用できます。
  • expires_in: integer -- セッションの有効期間 (秒)。

実行例

リクエストデータ

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "session.open_session",
  "params": {
  }
}

リクエスト実行

curl -H "Content-type: application/json" \
     -H "APIKey: 9c6f4574-89d1-4e3c-8af7-2549dc217fcf" \
     -H "Secret: aef8caingiej1ieNieJ3Phool4maeGohcies" \
     -X POST -d "@request.json" \
     https://localhost/api/v2/session/jsonrpc

レスポンス

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