RESTful API エンドポイント (authentication)

authenticationエンドポイントについて

認証を行いアクセストークンを発行します。環境変数「api_use_cookie」指定のある時、あわせてクッキーをセットします(初期値はfalse)。

エンドポイント

/api/v1/authentication

メソッド

POST
  • リクエストボディに JSONを指定するか、パラメタを送信します。
  • 「remember」はオプションで、環境変数「api_allow_remember」指定のある時、アクセストークンが 1年間有効になります。  
  • authentication成功後に認証付きリクエストを送信するには「X-PCMSX-Authorization」リクエストヘッダを付けてアクセスします。

JSON

{
    "name" : "ユーザー名",
    "password" : "ユーザーのパスワード",
    "remember" : true
}

パラメタ

?name=ユーザー名&password=ユーザーのパスワード&remember=1

レスポンス(成功時)

{
    "access_token": "アクセストークン",
    "expires_in": 有効期限(UNIXタイムスタンプ)
}

レスポンス・エラー

共通レスポンスエラーについてはこちら を参照ください。

許可されないリクエストメソッド

{
    "status": 400,
    "message": "Method リクエストメソッド not allowed."
}

JSONのパースエラー

{
    "status": 400,
    "message": "Invalid request."
}

パラメタが不足している

{
    "status": 401,
    "message": "Name and password are required."
}

認証に失敗したか、ユーザーがロックアウトされている

{
    "status": 401,
    "message": "Authentication faild."
}

IPアドレスがロックアウトされている

{
    "status": 401,
    "message": "This IP address was locked out."
}