APIリファレンス

command.mkd †

ルームに参加するためのコマンドファイルを返す。

URL †

http://web-api.soba-project.com/webapi/1.4/command.mkd

認証 †

必須。 ただし、HTTPヘッダにではなく、クエリーパラメータとして認証情報を渡す。

パラメータ †

• rid: 必須。参加するルームのID。
• auth: 必須。認証情報。
• redirect_url: オプション。エラー時のリダイレクト先。
• password: オプション。ルームのパスワード。

注意 †

• このAPIのURLはユーザーがブラウザで直接アクセスすることを想定している。
• このAPIが返すのはコマンドファイルそのものである。XML形式のデータではない。
• このルーム情報にもとづいて作成されたセッションが存在しなければ新たにセッションを作成するコマンドファイルを返す。
• すでにこのルーム情報にもとづいて作成されたセッションがあればそのセッションに参加するコマンドファイルを返す。
• このAPIが返すデータのMIMEタイプはapplication/x-soba-framework
• 認証情報は毎回違うものでなければならないので、同じルームに入り直す場合は認証情報を新しいものに作り直す必要がある。
• authパラメータにセットするのは他のAPIでAuthorizationヘッダにセットする「SobaAuth・・・」の文字列をURLエンコードしたもの

レスポンス †

 REQUEST 32 CREATE_SESSION 1.0
 Session-Application:SobaAP:portal_session
 Session-Publish:true
 Session-Name:test
 Session-Info:test
 Session-Id:Soba:Session:z8kflt+9ugxnorjs5+1wxajltden8+fyl575v128
 Soba-Config-URL:http://mieruka.soba-project.com/soba/userenv/001/000/000/000/000/229/1uv1fb8gygdu
 Owner-Id:Soba:User:MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCQ4jlic5TEbp519RGZUTW5qd4uugDHFJYJeRZj28o7BtfARwCgqG9dbQ7VKnVBuctqFP/wTIl88089E6z1o6Tw+PeY4YReIxUD3JwrvoxeTP7lKLgGSnDn0EeJMeOYjWJUkx3y82REaiF81Up+LWHqiC1AKsegS13Y5GFIRI3MPwIDAQAB
 ActionID:ABCDEFG
 GroupName:soba
 Password:d41d8cd98f00b204e9800998ecf8427e