REST API リファレンス
- ドキュメントトップ
-
共通
-
プッシュ通知
-
会員管理・認証
-
データストア
-
ファイルストア
-
スクリプト
共通ドキュメント
会員ログイン
Contents |
注意
APIパスにパスワードを含めずにリクエストできるため、
POSTメソッドの会員ログインAPIの利用を推奨しています。
会員ログインAPIについて
リクエストの会員名、パスワードが会員登録されていた場合に、
ログイン成功としセッショントークンの払い出しを行います。
メールアドレス認証が許可されている場合は、
メールアドレスとパスワードによるログインが可能になります。
基本仕様
- APIパス
- 会員名での認証を行う場合: /login?userName=YOUR_USER_NAME&password=YOUR_PASSWORD
- メールアドレスでの認証を行う場合: /login?mailAddress=YOUR_MAIL_ADDRESS&password=YOUR_PASSWORD
- メソッド:GET
リクエストヘッダー
シグネチャやAPIキーなどの詳細は「共通フォーマット」を参照してください。
フィールド名 | 内容 |
---|---|
Content-Type | application/json |
リクエストコンテント
会員ログイン時は、会員名かメールアドレスのいずれかを指定する必要があります。
ただし、両方を指定することはできません。
パラメータ名 | 説明 | データ型 | 必須 | バリデーション |
---|---|---|---|---|
userName | 会員名 | 文字列 | △ | 存在チェック 有効値チェック 相関チェック |
password | password | 文字列 | ○ | |
mailAddress | メールアドレス | 文字列 | △ | 相関チェック |
HTTPステータス
ステータスコード | 説明 |
---|---|
200 | ログイン完了 |
レスポンスヘッダー
フィールド名 | 値 |
---|---|
Content-Type | application/json |
レスポンスコンテント
パラメータ名 | 説明 | データ型 | 備考 |
---|---|---|---|
objectId | オブジェクトID | 文字列 | |
userName | 会員名 | 文字列 | |
authData | OAuth認証情報 | 配列 | 会員管理のデータ取得時にSNS認証データを含める設定を行っている場合のみOAuth認証情報を返却します。 |
mailAddressConfirm | メールアドレス確認状態 | 真偽値 | |
mailAddress | メールアドレス | 文字列 | |
createDate | 登録日時 | 日付 | |
updateDate | 更新日時 | 日付 | |
sessionToken | セッショントークン | 文字列 | |
- | 追加フィールド | - |
リクエストサンプル
curl -v -X GET -G \
-H "X-NCMB-Application-Key: 578ebb84b9036498858ce0aad14ed0b5a662a102ccca34f0033ff20a1f200786" \
-H "X-NCMB-Timestamp: 2013-08-14T15:46:25.543" \
-H "X-NCMB-Signature: CdqzmebhxNKhJe+VTTXCjdU+vfmf1SaHczr2p9iIs7I=" \
-H "Content-Type: application/json" \
--data-urlencode 'password=passwd' --data-urlencode 'userName=user01' \
https://mbaas.api.nifcloud.com/2013-09-01/login
レスポンスサンプル
{
"objectId":"09Mp23m4bEOInUqT",
"userName":"user01",
"mailAddress":null,
"mailAddressConfirm":null,
"sessionToken":"ebDH8TtmLoygzjqjaI4EWFfxc",
"createDate":"2013-08-28T07:46:09.801Z",
"updateDate":"2013-08-30T05:32:03.868Z"
}
お探しの内容が見つからなかった場合はユーザーコミュニティ
もご活用ください。(回答保証はいたしかねます)
なお、 Expertプラン以上のお客様はテクニカルサポートにてご質問を承らせて頂きます。
推奨画面サイズ1024×768px以上