說(shuō)明
1. 本系統(tǒng)所有接口均為HTTP請(qǐng)求
2. 用戶(hù)登錄驗(yàn)證成功后也殖，系統(tǒng)將返回Token，后續(xù)訪(fǎng)問(wèn)其他接口時(shí)，前端需要通過(guò)token查詢(xún)參數(shù)攜帶Token。
3. 接口URL中`:`說(shuō)明：如果接口中包含冒號(hào)，則說(shuō)明其后的字段為一個(gè)參數(shù)瓢颅。例如接口URL： /user/idencode/:telphone 中的`telphone`則表示為一個(gè)參數(shù)，在實(shí)際使用此接口時(shí)需要將其替換為具體的內(nèi)容。
4. 不需要登錄的接口如下：
注冊(cè)
登錄
獲取驗(yàn)證碼
5. 參數(shù)字段中包含`?`的說(shuō)明：如果參數(shù)字段以`?`結(jié)尾何暇，那么說(shuō)明此參數(shù)為可選參數(shù)。
場(chǎng)景相關(guān)
新增/更新場(chǎng)景
接口
/freeserver-ocelot/scene/upsert
請(qǐng)求方式
POST
參數(shù)類(lèi)型
application/json
參數(shù)
{
pid?: string,
name: string,
detail?: Object,
share?:boolean
}
pid: 更新的場(chǎng)景的pid凛驮，不傳則新建一個(gè)場(chǎng)景裆站。
name: 場(chǎng)景名字。
detail:場(chǎng)景其他信息黔夭。
share:是否公開(kāi)宏胯，默認(rèn)false不公開(kāi)
返回結(jié)果
正常：
{"stat":0,"msg":"成功","val":pid}
異常：
{"stat":非0數(shù)字，"msg"："對(duì)應(yīng)錯(cuò)誤信息"}
查詢(xún)單個(gè)場(chǎng)景的詳細(xì)信息
接口
/freeserver-ocelot/scene/getone/:pid
請(qǐng)求方式
GET
參數(shù)
無(wú)
返回結(jié)果
正常：
{"stat":0, "msg":"成功", val:{pid, name, userid, createTime}}
錯(cuò)誤：
{"stat":非0數(shù)字, "msg":"錯(cuò)誤信息"}
獲取全部場(chǎng)景
接口
/freeserver-ocelot/scene/getall
請(qǐng)求方式
POST
參數(shù)
{
keyword?: string,
offset?: number,
pagecount: number本姥，
share?: boolean
}
keyword:獲取包含關(guān)鍵字的所有場(chǎng)景（關(guān)鍵字根據(jù)name獲燃缗邸）
offset: 分頁(yè)的偏移量。其值為：(頁(yè)數(shù)-1)*每頁(yè)個(gè)數(shù)婚惫。默認(rèn)值0.
pagecount: 每頁(yè)數(shù)量氛赐。默認(rèn)值20
share:true獲取公開(kāi)的場(chǎng)景魂爪，false獲取非公開(kāi)的場(chǎng)景，不傳獲取所有場(chǎng)景
返回結(jié)果
正常：
{"stat":0, "msg":"成功", val:[]}
錯(cuò)誤：
{"stat":非0數(shù)字, "msg":"錯(cuò)誤信息"}
獲取全部場(chǎng)景個(gè)數(shù)
接口
/freeserver-ocelot/scene/count
請(qǐng)求方式
POST
參數(shù)
{
keyword?: string
}
keyword： 搜索的關(guān)鍵字
返回結(jié)果
正常：
{"stat":0, "msg":"成功", val:場(chǎng)景個(gè)數(shù)}
錯(cuò)誤：
{"stat":非0數(shù)字, "msg":"錯(cuò)誤信息"}
刪除一個(gè)場(chǎng)景
接口
/freeserver-ocelot/scene/remove/:pid
請(qǐng)求方式
GET
參數(shù)
無(wú)
返回結(jié)果
正常：
{"stat":0, "msg":"成功"}
錯(cuò)誤：
{"stat":非0數(shù)字, "msg":"錯(cuò)誤信息"}
獲取accesskey分享后的url
接口
/freeserver-ocelot/scene/getcapaurl
請(qǐng)求方式
POST
參數(shù)
{
pid: string,
accesskey:string
}
返回結(jié)果
正常：
{"stat":0, "msg":"成功", val:url}
錯(cuò)誤：
{"stat":非0數(shù)字, "msg":"錯(cuò)誤信息"}
