星期五, 2月 22, 2013

使用BigBlueButton API


使用BigBlueButton API 文件 written by Max

官方wiki
https://code.google.com/p/bigbluebutton/wiki/API


測試主機
http://x.y.z.w/

測試主機的salt : dfc658adec2de8a5d56b06ea51089883

Step 1:
建立會議的方式

舉例來說
http://x.y.z.w/bigbluebutton/api/create?name=Test&meetingID=test01&moderatorPW=mp&attendeePW=ap&checksum=5bb1dd0a153abffedb7abd96825fbecb32fef020

要建立會議, 要給建立聊天室的資料
create?name=Test&meetingID=test01&moderatorPW=mp&attendeePW=ap 取出
拿掉?號
createname=Test&meetingID=test01&moderatorPW=mp&attendeePW=ap

name=Test 會議名稱, 如果有空白字元使用+來串聯
meetingID 會議ID
moderatorPW 主持人密碼
attendeePW 參加人密碼

createname=Test&meetingID=test01&moderatorPW=mp&attendeePW=ap 加上 salt

結果為
createname=Test&meetingID=test01&moderatorPW=mp&attendeePW=apdfc658adec2de8a5d56b06ea51089883

將此一字串藉由SHA1演算法產生雜湊值
可以使用網頁的方式來產生雜湊值
將上面的 createname=Test&meetingID=test01&moderatorPW=mp&attendeePW=apdfc658adec2de8a5d56b06ea51089883  
貼入 http://pajhome.org.uk/crypt/md5/ 網頁內的 Input 欄位
點選 SHA1 按鈕, 產生雜湊值

結果如下
5bb1dd0a153abffedb7abd96825fbecb32fef020
createname=Test&meetingID=test01&moderatorPW=mp&attendeePW=apdfc658adec2de8a5d56b06ea51089883  

去除 salt , 結果為
createname=Test&meetingID=test01&moderatorPW=mp&attendeePW=ap

加上剛剛產生的雜湊值 &checksum=5bb1dd0a153abffedb7abd96825fbecb32fef020

結果為
createname=Test&meetingID=test01&moderatorPW=mp&attendeePW=ap&checksum=5bb1dd0a153abffedb7abd96825fbecb32fef020

將這串字串貼於BigBlueButton 主機 URL /bigbluebutton/api 下, 並加上 ?

create?name=Test&meetingID=test01&moderatorPW=mp&attendeePW=ap&checksum=5bb1dd0a153abffedb7abd96825fbecb32fef020


完整URL 如下

http://
x.y.z.w/bigbluebutton/api/create?name=Test&meetingID=test01&moderatorPW=mp&attendeePW=ap&checksum=5bb1dd0a153abffedb7abd96825fbecb32fef020

此時Server 會回應 建立成功

<response>

<returncode>SUCCESS</returncode>
<meetingID>test01</meetingID>
<attendeePW>ap</attendeePW>
<moderatorPW>mp</moderatorPW>
<createTime>1359709413228</createTime>
<hasBeenForciblyEnded>false</hasBeenForciblyEnded>
<messageKey>duplicateWarning</messageKey>
<message>
This conference was already in existence and may currently be in progress.
</message>
</response>

Step 2:
接下來加入聊天室

http://
x.y.z.w/bigbluebutton/api/join?meetingID=test01&password=mp&fullName=John&checksum=091148f421ce895dcd333fbe34f514050f9adaca

給入加入聊天室的資料
joinmeetingID=test01&password=mp&fullName=John
meetingID 加入聊天室的ID
password 進入聊天室的密碼
fullName 人員姓名

joinmeetingID=test01&password=mp&fullName=John 加上 salt

結果為 joinmeetingID=test01&password=mp&fullName=Johndfc658adec2de8a5d56b06ea51089883

將此一字串藉由SHA1演算法產生雜湊值
可以使用網頁的方式來產生雜湊值
將上面的 joinmeetingID=test01&password=mp&fullName=Johndfc658adec2de8a5d56b06ea51089883  
貼入 http://pajhome.org.uk/crypt/md5/ 網頁內的 Input 欄位
點選 SHA1 按鈕, 產生雜湊值

結果如下
091148f421ce895dcd333fbe34f514050f9adaca

joinmeetingID=test01&password=mp&fullName=Johndfc658adec2de8a5d56b06ea51089883

去除 salt 部分

結果為
joinmeetingID=test01&password=mp&fullName=John  

加上剛剛產生的雜湊值 &checksum=091148f421ce895dcd333fbe34f514050f9adaca

結果為

joinmeetingID=test01&password=mp&fullName=John&checksum=091148f421ce895dcd333fbe34f514050f9adaca

將這串字串貼於BigBlueButton 主機 URL /bigbluebutton/api 下, 並加上 ?

http://
x.y.z.w/bigbluebutton/api/join?meetingID=test01&password=mp&fullName=John&checksum=091148f421ce895dcd333fbe34f514050f9adaca

即可開啟聊天室參加會議