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

Obtain OBJ File

Basic Information

Path： /scene/getSceneObj

Method： POST

Interface Description：

Request Parameters

Headers

Parameter Name	Parameter Value	Required or not	Example	Remarks
Content-Type	application/json	Yes
Authorization		Yes		appkey

Body

Name	Type	Required or not	Default Value	Remarks	Other Information
sceneCode	string	Required		Scene Code

ReturnData

Name	Type	Required or not	Remarks	Other Information
code	number	Optional
message	string	Optional
data	string []	Optional		Item Type: string
├─		Optional	Download Link
success	boolean	Optional
timestamp	number	Optional

Get Panorama Image

Basic Information

Path： /scene/getScenePanorama

Method： POST

Interface Description：

Request Parameters

Headers

Parameter Name	Parameter Value	Required or not	Example	Remarks
Content-Type	application/json	Yes
Authorization		Yes		appkey

Body

Name	Type	Required or not	Default Value	Remarks	Other Information
sceneCode	string	Required		Scene Code

ReturnData

Name	Type	Required or not	Remarks	Other Information
code	number	Optional
message	string	Optional
data	string []	Optional		item Type: string
├─		Optional	Download Link
success	boolean	Optional
timestamp	number	Optional

Obtain Scene List

Basic Information

Path： /scene/getSceneList

Method： POST

Interface Description：

Request Parameters

Headers

Parameter Name	Parameter Value	Required or not	Example	Remarks
Content-Type	application/json	Yes
Authorization		Yes		User appkey

Body

Name	Type	Required or not	Remarks
cameraType	string	Optional	Camera Type（mega-激光，kankan-看看、看见），Not specified, default to all
pageNum	number	Optional	Page Number
pageSize	number	Optional	Page Size

ReturnData

Name	Type	Required or not	Remarks	Other Information
code	number	Optional	Request Response Code (0-Success)
message	string	Optional
data	object	Optional
├─ pageNum	number	Optional	Page Number
├─ pageSize	number	Optional	Page Size
├─ total	number	Optional	Total
├─ list	object []	Optional	Current Page Data	item Type: object
├─ userName	null	Optional	Username
├─ cameraType	string	Optional	Camera Type
├─ sceneCode	string	Optional	Scene Code
├─ sceneName	string	Optional	Scene Name
├─ createTime	string	Optional	Creation Time
├─ shootCount	number	Optional	Number of Points
├─ snCode	string	Optional	Camera SN
success	boolean	Optional
timestamp	number	Optional

Obtain Scene Point Information

Basic Information

Path： /scene/getScenePointInfo

Method： POST

Interface Description：

Request Parameters

Headers

Parameter Name	Parameter Value	Required or not	Example	Remarks
Content-Type	application/json	Yes
Authorization		Yes		appkey

Body

Name	Type	Required or not	Default Value	Remarks	Other Information
sceneCode	string	Required		Scene Code

ReturnData

PRO | MINION Scene Example：
{
    "code":0,
    "message":"Success",
    "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
}

MEGA Scene Example：
{
    "code":0,
    "message":"Success",
    "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
}

Obtain Scene Editing Data

Basic Information

Path： /scene/getSceneViewUserFile

Method： POST

Interface Description：

Request Parameters

Headers

Parameter Name	Parameter Value	Required or not	Example	Remarks
Content-Type	application/json	Yes
Authorization	String	Yes	asdasdasdasd	appkey

Body

Name	Type	Required or not	Default Value	Remarks	Other Information
sceneCode	string	Required		Scene Code

ReturnData

Name	Type	Required or not	Remarks
code	number	Optional
message	string	Optional
data	string	Optional	Zip Package Link
success	boolean	Optional
timestamp	number	Optional

Scene Image Annotation Data Save and Modify

Basic Information

Path： /scene/sceneMarkShape/saveOrEdit

Method： POST

Interface Description：

Request Parameters

Headers

Parameter Name	Parameter Value	Required or not	Example	Remarks
Content-Type	application/json	Yes
Authorization		Yes		appkey

Body

Name	Type	Required or not	Remarks	Other Information
version	string	Required
shapes	object []	Required		item Type: object
├─ score	number	Required	Score Value
├─ color	number []	Required	rgbColor	item Type: number
├─		Optional
├─ bbox	number []	Required	Annotation Box 4-Point Data xyxy	item Type: number
├─		Optional
├─ label	string	Required	xywh Data
├─ category	string	Required	Category Name
imagePath	string	Required	图片Name路径
imageHeight	number	Required	Height
imageWidth	number	Required	Width
num	string	Required	Scene Code
id	number	Optional	Save as Empty, Modify with ID Data

ReturnData

Name	Type	Required or not	Remarks
code	number	Optional	0 for success
message	string	Optional
data	boolean	Optional
success	boolean	Optional
timestamp	number	Optional

Obtain Scene Spherical View Data

Basic Information

Path： /scene/getSceneVideo

Method： POST

Interface Description：

This interface takes longer to process, limit 60 seconds per request

Request Parameters

Headers

Parameter Name	Parameter Value	Required or not	Example	Remarks
Content-Type	application/json	Yes
Authorization	String	Yes	asdasdasdasd	appkey

Body

Name	Type	Required or not	Default Value	Remarks	Other Information
sceneCode	string	Required		Scene Code

ReturnData

Name	Type	Required or not	Remarks
code	number	Optional
message	string	Optional
data	string	Optional	Zip Package Link
success	boolean	Optional
timestamp	number	Optional

Obtain Scene Point Cloud and Depth Map

Basic Information

Path： /scene/getSceneRaw

Method： POST

Interface Description：

Request Parameters

Headers

Parameter Name	Parameter Value	Required or not	Example	Remarks
Content-Type	application/json	Yes
Authorization		Yes		用户appkey

Body

Name	Type	Required or not	Default Value	Remarks	Other Information
sceneCode	string	Required		Scene Code

ReturnData

Name	Type	Required or not	Remarks	Other Information
code	number	Optional
message	string	Optional
data	object []	Optional		item Type: object
├─ fileName	string	Required	Filename
├─ url	string	Required	Download path
success	boolean	Optional
timestamp	number	Optional

Get Login Token

Basic Information

Path： /user/v1/login

Method： POST

Interface Description：

Request Parameters

Headers

Parameter Name	Parameter Value	Required	Example	Note
Content-Type	application/json	yes
Authorization		yes		appkey

Body

Name	Type	Required	Default Value	Note	Other Information
userName	string	Required		Username
password	string	Required		Password（Plaintext）

Response Data

Name	Type	Required	Note
code	number	Optional
message	string	Optional
data	string	Optional	token
success	boolean	Optional
timestamp	number	Optional

apis.md 35 KB Historia Czysty

Obtain OBJ File

Basic Information

Request Parameters

ReturnData

Get Panorama Image

Basic Information

Request Parameters

ReturnData

Obtain Scene List

Basic Information

Request Parameters

ReturnData

Obtain Scene Point Information

Basic Information

Request Parameters

ReturnData

Obtain Scene Editing Data

Basic Information

Request Parameters

ReturnData

Scene Image Annotation Data Save and Modify

Basic Information

Request Parameters

ReturnData

Obtain Scene Spherical View Data

Basic Information

Request Parameters

ReturnData

Obtain Scene Point Cloud and Depth Map

Basic Information

Request Parameters

ReturnData

Get Login Token

Basic Information

Request Parameters

Response Data

apis.md 35 KB

Historia Czysty