Skip to content
tsukkee edited this page Feb 24, 2011 · 9 revisions

公式APIドキュメント
https://github.com/lingr/lingr/wiki/Lingr-API

Lingr APIの簡易メモ(公式までのつなぎとして)
Firebugで適当に見ただけなので間違ってるかも知れません

基本

JSONベースでやりとりする
JSONPも可能

詳細はautoload/lingr.py見てください

エンドポイント

  • 通常 http://lingr.com/api/
  • Comet http://lingr.com:8080/api/

一覧

  • session/create セッションID作成
  • session/verify 作成済みのセッションIDを使い回す
  • session/destroy セッションIDを破棄する
  • session/set_presense online/offlineを設定する
  • user/get_rooms 部屋一覧を取得
  • room/show その部屋のメンバーと最近の発言30件を取得
  • room/get_archives その部屋の過去の発言を取得
  • room/subscribe その部屋からの通知を聞く
  • room/unsubscribe その部屋からの通知を聞かない
  • room/say その部屋に発言する
  • favorite/add Favaritesに追加
  • favorite/remove Favaritesから削除
    favoriteはAPIバージョン2が必要
  • event/observe Comet用

詳細

共通

リクエスト

callback: JSONP用のコールバック関数名を指定

レスポンス

status: リクエストが成功したかどうか(ok/error)

session/create

セッションID作成する

リクエスト

POST
user: ユーザ名
password: パスワード

レスポンス

session: セッションID
nickname: ニックネーム
public_id: パブリックID
is_online: online/offline
user.name: 表示名
user.username: ユーザ名

ユーザ名かパスワードが無効のときは
{status: “error”, code: “invalide_user_credentials”, … }
が返る

session/verify

作成済みのセッションIDを使い回す

リクエスト

GET
session: 作成済みのセッションID

レスポンス
session/createと同じ

セッションIDが無効のときは
{status: “error”, code: “invalid_session”, … }
が返る

session/destroy セッションIDを破棄する

session/set_presense online/offlineを設定する

user/get_rooms 部屋一覧を取得

room/show その部屋のメンバーと最近の発言30件を取得

room/get_archives その部屋の過去の発言を取得

room/subscribe その部屋からの通知を聞く

room/unsubscribe その部屋からの通知を聞かない

room/say その部屋に発言する

event/observe Comet用