新增场景分享配置
优质
小牛编辑
136浏览
2023-12-01
接口说明
新增场景分享配置
如需调用，请访问 开发者文档 来查看详细的接口使用说明
该接口仅开放给已获取SDK的开发者
API地址
POST /wish3dearth/api/scene/share/v1.0.0/addShareConfig
是否需要登录
是
请求字段说明
| 参数 | 类型 | 请求类型 | 是否必须 | 说明 |
|---|---|---|---|---|
| token | string | header | 是 | 当前登录用户的TOKEN |
| sceneId | string | formData | 是 | 场景ID |
| shareType | string | formData | 是 | 分享类型（1：公开， 2：设置密码访问） |
| password | string | formData | 否 | 打开分享场景时的密码 |
| expireTime | string | formData | 否 | 分享到期时间（时间蹉） |
响应字段说明
| 参数 | 类型 | 说明 |
|---|---|---|
| createBy | string | 场景分享者ID |
| createByName | string | 场景分享者名字 |
| createDate | string | 场景分享创建时间 |
| expireTime | string | 链接到期时间 |
| id | string | 场景分享ID |
| owner | string | 场景分享属有者ID |
| password | string | 链接密码 |
| remarks | string | 场景分享描述 |
| sceneId | string | 场景ID |
| sceneName | string | 场景名称 |
| shareType | string | 分享类型（1：公开， 2：设置密码访问） |
| shortUrl | string | 场景分享短链接 |
| viewCount | string | 预览次数 |
响应成功示例
{
"code": 0,
"data": {
"id": "0f2d9fdbac50409d803ce4c00a7c13ae",
"sceneId": "107d27560134177fcf1cacdf41251e73",
"shareType": "1",
"password": null,
"expireTime": null,
"viewCount": 0,
"owner": "c4ed11ced28d4534b5ab247d77d6abd7",
"createBy": "c4ed11ced28d4534b5ab247d77d6abd7",
"createDate": "2019-12-06 17:18:56",
"remarks": null,
"shortUrl": "http://10.16.30.108/w?s=y2E3ey",
"createByName": null,
"sceneName": null
},
"message": "成功"
}响应失败示例
{
"code": 500,
"message": "未知错误，请及时联系管理人员进行处理"
}响应接受类型
application/json
响应状态码
| HTTP状态码 | 原因 |
|---|---|
| 0 | 成功 |
| 200 | OK |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 10000 | token不能为空 |
| 10001 | token已失效,请重新登录 |
| 14004 | 获取团队信息失败 |
| 14056 | 场景ID不能为空 |
| 14084 | 场景分享类型为空 |
| 14087 | 到期日期错误 |
| 14089 | 分享密码为空 |
| 99998 | 非法请求 |
| 99999 | 服务器异常 |
示例代码
$.ajax({
url: '/wish3dearth/api/scene/share/v1.0.0/addShareConfig',
type: 'POST',
data: 'token=&sceneId=&shareType=&password=&expireTime=',
dataType: 'text',
cache: false,
contentType: 'application/json',
xhrFields: {
withCredentials: true
},
crossDomain: true,
success:function(data){
// 成功返回值
},
error:function(XMLHttpRequest, textStatus, errorThrown){
}
})