Session.create

session.create

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

翻訳日: 2007/04/13

原文リビジョン: 13


新しいAPIセッションを作ります。セッションを一度作ったなら、10分ごとに少なくとも1回、何らかのAPIコールをしてください。そうでないと、セッションタイムアウトして自動的に破棄されます。

HTTPメソッド

POST

パラメータ

api_key(必須)

あなたのAPIキー

client_type(オプション)

あなたのAPIクライアントの種類。指定するならば、"human"か"automaton"のいずれかでなければなりません。指定しないときのデフォルトはautomatonです。詳細はclient_typeを参照してください。

format(オプション)

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

callback(オプション)

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

認証

このメソッドは認証を必要としません。

応答の例

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

応答の詳細

成功したメソッド呼び出しの応答は以下のような要素を持ちます。

session

ユニークAPIセッションID

エラーコード

100: 不正HTTPメソッド

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

101: 無効なAPIキー

指定されたAPIキーが不正です。

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

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

118: 不正クライアントタイプ

指定されたクライアントタイプは無効です。

119: クライアントタイプが指定されていない

client typeパラメータが指定されていない。



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

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

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