# 项目管理

# 1 创建新项目

注意:每个appId只能创建10个项目,包括已删除的。

接口地址 方法 说明
BaseUrl/api/v1/project POST 创建新项目

RequestBody: Content-Type="application/json;charset=utf8"

参数 描述
name 必填,名称
enableCertificate 必填,true 创建app id+app cert+ token ; false 创建app id

响应数据:

实例:
[POST] https://192.168.2.251/client/api/v1/project
请求JSON数据:
{
	"name": "xxxxdddd",
	"enableCertificate": true
}
响应:
{
    "msg": "操作成功",
    "code": 200,
    "data": {
        "projectId": "nDh0REmc2ct",
        "name": "xxxxdddd",
        "appId": "60370f648613f149de55d2a8",
        "signkey": "c60446de5fe84d48b9e3f164d4c07d3e",
        "recordingServer": null,
        "status": "0",
        "createTime": "2021-02-25 10:45:56"
    }
}

# 2 获取指定项目

接口地址 方法 说明
BaseUrl/api/v1/project GET 获取指定项目

Parameters:

参数 描述
projectId 必填,项目Id

响应数据:

实例:
[GET] https://192.168.2.251/client/api/v1/project?projectId=nDh0REmc2ct
响应:
{
    "msg": "操作成功",
    "code": 200,
    "data": {
        "projectId": "nDh0REmc2ct",
        "name": "xxxxdddd",
        "appId": "60370f648613f149de55d2a8",
        "signkey": "c60446de5fe84d48b9e3f164d4c07d3e",
        "recordingServer": "",
        "status": "0",
        "createTime": "2021-02-25 10:45:57"
    }
}

# 3 删除指定项目

接口地址 方法 说明
BaseUrl/api/v1/project DELETE 删除指定项目

Parameters:

参数 描述
projectId 必填,项目Id

响应数据:

实例:
[DELETE] https://192.168.2.251/client/api/v1/project?projectId=nDh0REmc2ct
响应:
{
    "msg": "操作成功",
    "code": 200
}

# 4 获取所有项目

接口地址 方法 说明
BaseUrl/api/v1/projects GET 获取所有项目

响应数据:

实例:
[GET] https://192.168.2.251/client/api/v1/projects
响应:
{
    "total": 3,
    "rows": [
        {
            "projectId": "b1TjP2Y7OYX",
            "name": "ddd",
            "appId": "6017bf4c8f07d808b039258b",
            "signkey": "e8bed603a0a74fc4b6f6f3a52c2348a8",
            "recordingServer": "",
            "status": "0",
            "createTime": "2021-02-01 16:43:57"
        },
        {
            "projectId": "KLrb1iZNgpX",
            "name": "xxxxdddd",
            "appId": "6030db678613f149de55d2a7",
            "signkey": "fa41fa36f61b455c854f3ac8fa2492e0",
            "recordingServer": "",
            "status": "0",
            "createTime": "2021-02-20 17:50:50"
        },
        {
            "projectId": "cTSmFWmdsuj",
            "name": "xxxxdddd",
            "appId": "6030dd12c9ff7f49d264cc03",
            "signkey": "378e5f409dc147e88f445db5cf8c1f67",
            "recordingServer": "192.168.2.120:8080",
            "status": "0",
            "createTime": "2021-02-20 17:57:38"
        }
    ],
    "code": 200,
    "msg": "查询成功"
}

# 5 禁用或启用项目

接口地址 方法 说明
BaseUrl/api/v1/project_status POST 禁用或启用项目

RequestBody: Content-Type="application/json;charset=utf8"

参数 描述
projectId 必填,项目Id
status 必填,1启用,0禁用

响应数据:

实例:
[POST] https://192.168.2.251/client/api/v1/project_status
请求JSON数据:
{
	"projectId": "cTSmFWmdsuj",
	"status": "1"
}
响应:
{
    "msg": "操作成功",
    "code": 200,
    "data": {
        "projectId": "cTSmFWmdsuj",
        "name": "xxxxdddd",
        "appId": "6030dd12c9ff7f49d264cc03",
        "signkey": "378e5f409dc147e88f445db5cf8c1f67",
        "recordingServer": "192.168.2.120:8080",
        "status": "1",
        "createTime": "2021-02-20 17:57:38"
    }
}

# 6 设置录制服务器 IP

接口地址 方法 说明
BaseUrl/api/v1/recording_config POST 设置录制服务器 IP

RequestBody: Content-Type="application/json;charset=utf8"

参数 描述
projectId 项目ID
recording_server 录播服务器地址

响应数据:

实例:
[POST] https://192.168.2.251/client/api/v1/recording_config
请求JSON数据:
{
	"projectId": "cTSmFWmdsuj",
	"recordingServer": "192.168.2.120:8080"
}
响应:
{
    "msg": "操作成功",
    "code": 200,
    "data": {
        "projectId": "cTSmFWmdsuj",
        "name": "xxxxdddd",
        "appId": "6030dd12c9ff7f49d264cc03",
        "signkey": "378e5f409dc147e88f445db5cf8c1f67",
        "recordingServer": "192.168.2.120:8080",
        "status": "1",
        "createTime": "2021-02-20 17:57:38"
    }
}

# 7 启用或禁用主要 App 证书

接口地址 方法 说明
BaseUrl/api/v1/signkey POST 启用或禁用主要 App 证书

RequestBody: Content-Type="application/json;charset=utf8"

参数 描述
projectId 必填,项目Id
enable 必填,true 启用或 false禁用主要app证书

响应数据:

实例:
[POST] https://192.168.2.251/client/api/v1/signkey
请求JSON数据:
{
	"projectId": "cTSmFWmdsuj",
	"enable": true
}
响应:
{
    "msg": "操作成功",
    "code": 200,
    "data": {
        "projectId": "cTSmFWmdsuj",
        "name": "xxxxdddd",
        "appId": "6030dd12c9ff7f49d264cc03",
        "signkey": "3d865f67dbec448aad48ad2e7289e4f4",
        "recordingServer": "",
        "status": "1",
        "createTime": "2021-02-20 17:57:38"
    }
}

# 8 重置主要 App 证书

接口地址 方法 说明
BaseUrl/api/v1/reset_signkey POST 重置主要 App 证书

RequestBody: Content-Type="application/json;charset=utf8"

参数 描述
projectId 必填,项目Id

响应数据:

实例:
[POST] https://192.168.2.251/client/api/v1/reset_signkey
请求JSON数据:
{
	"projectId": "cTSmFWmdsuj"
}
响应:
{
    "msg": "操作成功",
    "code": 200,
    "data": {
        "projectId": "cTSmFWmdsuj",
        "name": "xxxxdddd",
        "appId": "6030dd12c9ff7f49d264cc03",
        "signkey": "3d865f67dbec448aad48ad2e7289e4f4",
        "recordingServer": "",
        "status": "1",
        "createTime": "2021-02-20 17:57:38"
    }
}