auth.login

auth.login

オリジナル: http://wiki.lingr.com/dev/show/AuthLogin

翻訳日: 2007/02/02

原文リビジョン: 10

APIセッション中で、ユーザ認証を行います。

いくつかのメソッドはユーザログインしている必要があったり、ユーザログインしているときとしていないときで動作が異なったりします。認証が必要だったり、動作が異なるメソッドについてはそれぞれのリファレンスで説明されています。

HTTPメソッド

POST

パラメータ

session(必須)

session.createで得たセッションID

email(必須)

Lingrに登録したログインのためのメールアドレス

password(必須)

ログインしようとするユーザに対応するパスワード

format(オプション)

希望の応答フォーマット。指定する場合はxmljsonを指定します。デフォルトxmlです。

callback(オプション)

応答フォーマットjsonを指定した場合、コールバック関数名を指定します。


認証

このメソッドは認証を必要としません。もしも同一セッション内で既に認証が行われていた場合、このメソッドは失敗します。

応答の例

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
</response>

応答の詳細

成功したメソッド呼び出しの応答は、特に追加要素を持ちません。


エラーコード

100: 不正HTTPメソッド

HTTPメソッドが間違っています。

102: セッションが無効

渡されたセッションIDが無効です

104: 不正な応答フォーマット

要求された応答フォーマットサポートされていません。

105: 無効なユーザ、もしくは無効なパスワード

ユーザが無効か、パスワードが無効、もしくはその両方です。

107: 既にログインしている

同一セッション中で、既に認証が行われている。

120: 不正文字コードエンコーディング

あなたが入力したデータUTF-8として不正エンコーディングを含んでいます。

詳細は「APIの基礎について学ぶ」を参照してください。