4dkankan-docs/pro-docs: 产品文档 @ 219f0824e7e2281084b2eb20fbae9088910f992e

获取obj文件

基本信息

Path： /scene/getSceneObj

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是		appkey

Body

名称	类型	是否必须	默认值	备注	其他信息
sceneCode	string	必须		场景码

返回数据

名称	类型	是否必须	备注	其他信息
code	number	非必须
message	string	非必须
data	string []	非必须		item 类型: string
├─		非必须	下载链接
success	boolean	非必须
timestamp	number	非必须

获取全景图

基本信息

Path： /scene/getScenePanorama

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是		appkey

Body

名称	类型	是否必须	默认值	备注	其他信息
sceneCode	string	必须		场景码

返回数据

名称	类型	是否必须	备注	其他信息
code	number	非必须
message	string	非必须
data	string []	非必须		item 类型: string
├─		非必须	下载链接
success	boolean	非必须
timestamp	number	非必须

获取场景列表

基本信息

Path： /scene/getSceneList

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是		用户appkey

Body

名称	类型	是否必须	备注
cameraType	string	非必须	相机类型（mega-激光，kankan-看看、看见），不填默认全部
pageNum	number	非必须	页码
pageSize	number	非必须	每页大小

返回数据

名称	类型	是否必须	备注	其他信息
code	number	非必须	请求响应码（0-成功）
message	string	非必须
data	object	非必须
├─ pageNum	number	非必须	页码
├─ pageSize	number	非必须	每页条数
├─ total	number	非必须	总数
├─ list	object []	非必须	当前页数据	item 类型: object
├─ userName	null	非必须	用户名
├─ cameraType	string	非必须	相机类型
├─ sceneCode	string	非必须	场景码
├─ sceneName	string	非必须	场景名称
├─ createTime	string	非必须	创建时间
├─ shootCount	number	非必须	点位数量
├─ snCode	string	非必须	相机编码
success	boolean	非必须
timestamp	number	非必须

获取场景点位信息

基本信息

Path： /scene/getScenePointInfo

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是		appkey

Body

名称	类型	是否必须	默认值	备注	其他信息
sceneCode	string	必须		场景码

返回数据

看看|看见场景示例：
{
    "code":0,
    "message":"成功",
    "data":[
        {
            "subgroup":0,
            "subdevice":0,
            "pose":{
                "rotation":{
                    "w":0.0056687597393,
                    "x":0.0041020903986,
                    "y":-0.0006555021159,
                    "z":0.9999753038622
                },
                "translation":{
                    "x":0.2480049928576,
                    "y":-0.1253160400283,
                    "z":0.0698075
                }
            },
            "visibles3":[
                1,
                2
            ],
            "visibles2":[
                1,
                2
            ],
            "puck":{
                "x":0.2480049928576,
                "y":-0.1253160400283,
                "z":-0.8756464839194
            },
            "id":0,
            "uuid":"0",
            "device":0,
            "visibles":[
                1,
                2
            ],
            "room":0,
            "group":1
        },
        {
            "subgroup":0,
            "subdevice":0,
            "pose":{
                "rotation":{
                    "w":0.488034808399,
                    "x":0.003275388833,
                    "y":-0.0025556977961,
                    "z":0.8728142792299
                },
                "translation":{
                    "x":0.5115810031314,
                    "y":0.0985001423026,
                    "z":0.0670305
                }
            },
            "visibles3":[
                0,
                2
            ],
            "visibles2":[
                0,
                2
            ],
            "puck":{
                "x":0.5115810031314,
                "y":0.0985001423026,
                "z":-0.8784234839194
            },
            "id":1,
            "uuid":"4",
            "device":2,
            "visibles":[
                0,
                2
            ],
            "room":0,
            "group":1
        },
        {
            "subgroup":0,
            "subdevice":0,
            "pose":{
                "rotation":{
                    "w":-0.2091556113663,
                    "x":0.0041477093186,
                    "y":0.0002411830965,
                    "z":0.9778735442644
                },
                "translation":{
                    "x":-0.5107311412508,
                    "y":0.1257464444695,
                    "z":0.0829645
                }
            },
            "visibles3":[
                0,
                1
            ],
            "visibles2":[
                0,
                1
            ],
            "puck":{
                "x":-0.5107311412508,
                "y":0.1257464444695,
                "z":-0.8624894839194
            },
            "id":2,
            "uuid":"8",
            "device":4,
            "visibles":[
                0,
                1
            ],
            "room":0,
            "group":1
        }
    ],
    "success":true,
    "timestamp":1679910791171
}

深时场景示例：
{
    "code":0,
    "message":"成功",
    "data":{
        "point":[
            {
                "datasetLocation":[
                    0,
                    0,
                    0
                ],
                "datasetFloorLocation":[
                    0,
                    0,
                    -1.229380953505
                ],
                "location":[
                    113.59572587333702,
                    22.366579193007002,
                    0
                ],
                "id":"1630115697503375360",
                "datasetOrientation":[
                    0.1098153948208,
                    0.0053919050116,
                    -0.0093916045299,
                    0.9938930043949
                ],
                "fileId":"00000"
            }
        ]
    },
    "success":true,
    "timestamp":1679910917030
}

获取场景编辑数据

基本信息

Path： /scene/getSceneViewUserFile

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization	String	是	asdasdasdasd	appkey

Body

名称	类型	是否必须	默认值	备注	其他信息
sceneCode	string	必须		场景码

返回数据

名称	类型	是否必须	备注
code	number	非必须
message	string	非必须
data	string	非必须	压缩包链接
success	boolean	非必须
timestamp	number	非必须

场景图片标注数据保存修改

基本信息

Path： /scene/sceneMarkShape/saveOrEdit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是		appkey

Body

名称	类型	是否必须	备注	其他信息
version	string	必须
shapes	object []	必须		item 类型: object
├─ score	number	必须	分数值
├─ color	number []	必须	rgb颜色	item 类型: number
├─		非必须
├─ bbox	number []	必须	标注框4点位数据 xyxy	item 类型: number
├─		非必须
├─ label	string	必须	xywh 数据
├─ category	string	必须	类别名
imagePath	string	必须	图片名称路径
imageHeight	number	必须	高
imageWidth	number	必须	宽
num	string	必须	场景码
id	number	非必须	保存为空，修改带id数据

返回数据

名称	类型	是否必须	备注
code	number	非必须	0 为成功
message	string	非必须
data	boolean	非必须
success	boolean	非必须
timestamp	number	非必须

获取场景球幕视数据

基本信息

Path： /scene/getSceneVideo

Method： POST

接口描述：

此接口耗时较长，限流60秒一次

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization	String	是	asdasdasdasd	appkey

Body

名称	类型	是否必须	默认值	备注	其他信息
sceneCode	string	必须		场景码

返回数据

名称	类型	是否必须	备注
code	number	非必须
message	string	非必须
data	string	非必须	压缩包链接
success	boolean	非必须
timestamp	number	非必须

获取场景点云和深度图

基本信息

Path： /scene/getSceneRaw

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是		用户appkey

Body

名称	类型	是否必须	默认值	备注	其他信息
sceneCode	string	必须		场景码

返回数据

名称	类型	是否必须	备注	其他信息
code	number	非必须
message	string	非必须
data	object []	非必须		item 类型: object
├─ fileName	string	必须	文件名
├─ url	string	必须	下载路径
success	boolean	非必须
timestamp	number	非必须

获取登录Token

基本信息

Path： /user/v1/login

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是		appkey

Body

名称	类型	是否必须	默认值	备注	其他信息
userName	string	必须		用户名
password	string	必须		密码（明文）

返回数据

名称	类型	是否必须	备注
code	number	非必须
message	string	非必须
data	string	非必须	token
success	boolean	非必须
timestamp	number	非必须

根据官网token获取带看房间列表

基本信息

Path： /takelook/roomList

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	备注
Content-Type	application/json	是
Authorization		是	appkey
fd-takelook-token		是	/user/v1/login中获取的token

Body

名称	类型	是否必须	默认值	备注	其他信息
pageNum	string	必须		当前页
pageSize	string	必须		页码

返回数据

名称	类型	是否必须	备注	其他信息
code	number	非必须
message	string	非必须
data	object	非必须
├─ pageNum	number	非必须
├─ pageSize	number	非必须
├─ total	number	非必须
├─ list	object []	非必须		item 类型: object
├─ roomId	string	必须	房间id
├─ roomTitle	string	必须	房间标题
├─ roomInfo	string	必须	房间简介
├─ roomHostName	string	必须	房间主持人昵称
├─ roomUserName	string	必须	房间主持人用户名
├─ roomCoverUrl	string	必须	房间封面图
├─ roomShareCode	null,string	必须	房间分享二维码
├─ roomHostCode	null,string	必须	房间主持人二维码
├─ roomShareUrl	null	必须	房间分享链接
├─ tbStatus	number	必须
├─ createTime	string	必须
├─ updateTime	string	必须
├─ roomStatus	number	必须	//房间状态，0 未开启，1进行中，2已关闭
├─ lastLookTime	null,string	必须
├─ isShow	number	必须	//房间状态，0 不显示，1显示
├─ useStartTime	string	必须	使用开始时间
├─ useEndTime	string	必须	使用结束时间
├─ visitPassword	null	必须	房间密码
├─ takeLookLock	number	必须	带看锁，0没密码，1有密码
├─ freeRoamLock	number	必须	自由漫游锁，0没密码，1有密码
├─ maxMan	number	必须	房间最大人数设置
├─ hostStatus	number	必须	主持人状态，0未进入房间，1已进入房间
├─ head	string,null	必须	头像
├─ gps	null	必须	场景gps
├─ platform	string	必须
├─ image	string []	必须	图片	item 类型: string
├─		非必须
├─ video	string []	必须	视频	item 类型: string
├─		非必须
├─ roomUserId	null	必须
├─ roomViewCount	number	必须	房间访问次数
├─ useTimeList	string []	必须		item 类型: string
├─		非必须
success	boolean	非必须
timestamp	number	非必须

apis.md 48 KB History Raw

获取obj文件

基本信息

请求参数

返回数据

获取全景图

基本信息

请求参数

返回数据

获取场景列表

基本信息

请求参数

返回数据

获取场景点位信息

基本信息

请求参数

返回数据

获取场景编辑数据

基本信息

请求参数

返回数据

场景图片标注数据保存修改

基本信息

请求参数

返回数据

获取场景球幕视数据

基本信息

请求参数

返回数据

获取场景点云和深度图

基本信息

请求参数

返回数据

获取登录Token

基本信息

请求参数

返回数据

根据官网token获取带看房间列表

基本信息

请求参数

返回数据

apis.md 48 KB

History Raw