Hatena::ブログ(Diary)

TAKUYA’s CODE RECORDER このページをアンテナに追加 RSSフィード

2009-06-24

AMEE API / Authentication

|

http://my.amee.com/developers/wiki/Authentication

  • Overview
    • AMEE APIをインターフェイスとして使う前に、認証を得る必要がある
    • 認証を得るためには、2つの方法がある
      • HTTP Basic authentication
      • authenticated sessions
  • HTTP Basic
    • AMEEの認証を得る最もシンプルな方法は、リクエスト毎にログイン情報も送ることだ
      • HTTPの基本的なログインメソッドを使って
      • 例えば、curlを使う
      • curl http://stage.amee.com/data -H "accept:application/xml" -u username:password
    • リクエスト毎にログイン情報を送るので、この方法はHTTPSコネクションの場合のみ利用すべき
    • authenticated session methodと比べたら、APIのパフォーマンスは良くない可能性がある
  • Authenticated Sessions
    • 認証されたセッションを作った場合、the '/auth' API resourceからauthTokenを要求する必要がある
      • URL: http://{server}/auth
      • Method: POST
      • Request format: application/x-www-form-urlencoded
      • Response format: application/xml, application/json
      • Response code: 200 OK
      • Response body: Details of the authenticated user, including API version.
      • Extra data: "authToken" cookie and header, containing the authentication token that should be used for subsequent calls.
      • その他、パラメータ
    • 一度、authTokenを取得すれば、その後のリクエストでは、ログイン情報を全て送る必要はなく、そのトークンだけが必要となる
      • そのトークンを、"authToken"というcookie名称の中に入れなければならない
    • Session Duration
      • セッションが持続する時間は限られている
      • 最大時間は2時間
      • アイドル時間の最大時間は30分
      • 認証が失敗したら、再度、認証させるようなロジックを組むことが重要
      • トークンの期限切れとなったら、APIは401ステータス(UNAUTHORIZED)を返す
    • この後、参考例あり
Connection: close