REST API 会員API
最終更新日 2015-9-1

ログインする

会員登録済みのログインID、パスワードでログインします。

基本仕様

リクエストされたログインID、パスワードが会員登録済みの場合、ストアトークンを発行します。また、本APIでは指定回数以上サインインに失敗するとアカウントロックが発生します。アカウントロック時のレスポンス、返却されるコンテントに関しては、共通仕様 / アカウントロック機能 をご参照ください。

HTTPメソッド

POST

エンドポイント

/v1/tkn/{データストアID}/{アプリID}

リクエスト

トークンには アプリトークンを指定します。指定箇所はヘッダX-APPIARIES-TOKENまたはクエリaccess_tokenに指定します。

ヘッダ

キー 必須 説明 備考
X-APPIARIES-TOKEN △(*1) アプリトークンを指定ください。
Content-Type application/json

クエリ

キー 必須 説明 備考
access_token △(*1) アプリトークンを指定ください。
proc create 省略可能
get true 省略可能

(*1) – ヘッダX-APPIARIES-TOKENまたはクエリaccess_tokenでいずれか指定。

コンテント

キー 必須 説明 データ型 備考
login_id △(*2) ログインID String
email △(*2) メールアドレス String (*3)
pw パスワード String

(*2)~ログインIDまたはメールアドレス必須。

(*3)~コントロールパネルの会員管理 / 基本設定にて、会員のメールアドレス認証が設定するの場合指定可能。

成功時レスポンス

リクエスト成功時のレスポンスに関して記述します。エラー時のレスポンスに関しては、 共通エラーレスポンスを参照ください。

ヘッダ

キー名 説明
Content-Type application/json
Location 登録された会員情報を取得するための参照URL

HTTPステータス

ステータスコード 説明
201 ログイン成功

コンテント

ログインが成功した場合

キー名 説明 データ型 備考
_id ユーザID String
_token ストアトークン String
user_id ユーザID String Deprecated〜将来的に使用できなくなるため_idを使用するようにしてください。

エラーレスポンス

エラー発生時のレスポンスは、共通仕様の共通エラーレスポンスを参照。