开发者平台二次开发接口

1.7添加应用

简要描述
  • 添加应用
请求URL
  • {{https://www.pingxingyun.com/console/api}}/poc/hostAppli/add
请求方式
  • post
Header
字段名 示例值 必选 类型 说明
Key ** 是 string 调用开发者平台接口必传参数，在开发者平台后台，账号—安全设置—秘钥管理查看，平台秘钥Key
timestamp 8641724046238887 是 string 当前时间戳，单位：毫秒
signature AD3B11BC135C39A7CA0058D8826ED74492F65142 是 string 在开发者平台后台，账号—安全设置—秘钥管理查看Key&Secret：用于二次开发的接入凭证 【使用规则】
请求参数示例
{
  "appliName": "testking",
  "appliType":2,
  "zipFile": "1275109112912281600.zip",
  "appliPath": "20240819150823124",
  "uploadId": "AAF2362444314B9EB163D7E852E4EBA0",
  "exeFilePath": "WindowsNoEditor/ceshiV12/Binaries/Win64/ceshiV12.exe",
  "exeFilePathList": "WindowsNoEditor/ceshiV12/Binaries/Win64/ceshiV12.exe",
  "param": "",
  "initWinSize": 0,
  "initCursorMode": 0,
  "fullScreenMode": 0,
  "screenBgColor": "",
  "startProcType": 0,
  "useGamepad": 0,
  "mobileForceLandscape": 1,
  "mobileVirtualJoystick": 1,
  "mouseZoomDirection": 1,
  "playerListToggle": 1,
  "limitMaxFps": 1,
  "touchOperateMode": "mouse",
  "dcs": "1",
  "playMode": "0",
  "syncRegions": "HDSQ-B",
  "serverStandard": "2k",
  "noOperaTimeout": 5,
  "serviceItemList": [
    {
      "id": "876869352356547789"
    },
    {
      "id": "876869513688121344"
    }
  ]
}
请求json字段说明
字段名 必选 类型 说明
appliName 是 string 应用名称
zipFile 是 string 设置为1.4分片上传接口返回的zipFilePath值
appliPath 是 string 设置为1.4分片上传接口返回的appliPath值
uploadId 是 string 一个文件上传的整体标识，设置为1.3获取上传Id的uploadId的值
exeFilePath 是 string 选中的exeFilePathList列表中某个值
exeFilePathList 是 string 设置为1.4分片上传接口返回的exeFilePathList值
param 否 string Unreal引擎开发的应用程序有可能需要启动参数， 可通过，本地直接运行->启动【任务管理器】->【详细信息】->鼠标置于状态栏， 右键【选择列】->勾选【命令行】，->然后找到正在运行的UE4 课程，查看命令行参数
initWinSize 是 string 初始化窗口方式 0：按照原始窗口大小显示 2：尽量填充容器（保存宽高比） 3：完全填充容器（裁剪） 4：完全填充容器（拉伸） 默认为0： 按照原始窗口大小显示
initCursorMode 是 string 鼠标模式，默认是0。0：非锁定模式。1：锁定模式
fullScreenMode 是 string 全屏模式（效果等同F11键），默认是0；0：手动触发，按下F11键盘或者是左下角的全屏按钮。1：首次点击屏幕使用的时候触发 2：每次点击屏幕的时候触发。
screenBgColor 否 string web客户端的背景色，默认为空，即无背景色
startProcType 是 string 独占模式下启动模式，大部分为标准模式：0，少部分为兼容模式：1
useGamepad 是 string 该应用是否使用手柄，默认为0；0：不使用，1：使用
mobileForceLandscape 是 string 手机端时是否强制横屏，默认为1；0：否，1：是
mobileVirtualJoystick 是 string 手机端是否初始显示虚拟摇杆，默认为1；0：否，1：是
mouseZoomDirection 是 string 触屏放大手势与滚轮映射，默认为1；0：滚轮下滚，1：滚轮上滚
playerListToggle 是 string 互动模式是否显示玩家列表，默认为1；0：否，1：是
limitMaxFps 是 string 是否限制应用帧率，默认为1；0：否，1：是
touchOperateMode 是 string 移动端的触摸指令模式，mouse：鼠标，touch：触摸，touch时，客户端的触摸指令直接以windows的原生触摸指令发送给渲染服务器
dcs 是 string 是否开启数据通道，0：否，1：是
playMode 是 string 是否开启互动模式，0：否，1：是
audioInput 否 string 是否开启客户端音频输入，0：否，1：是
syncRegions 是 string 应用所同步区域，根据1.5获取用户可选区域，设置多可用区的话，使用竖线拼接regionId，specifiedRegionList中的regionId必须传入。
serviceItemList 是 array 增值服务的列表，以下字段需要完全参照示例中的serviceItemList传递。托管应用基础功能-后付费这一项必须传递，数据通道-后付费，多人互动-后付费需按照使用情况传递，如果dcs为1，表示开启数据通道，playMode为1，表示开启互动模式。
serviceItemList.id 是 string “id”: “876869352356547789”或“876869353356547889” 必传，表示基础功能(2k)/基础功能(4k)， “id”: “876869513688121344”，表示数据通道， “id”: “876869570940370944”表示互动模式； “id”: “876869618457934140”表示是否开启客户端音频输入
serverStandard 是 string 规格， “2k”、”4k”(注：和serviceItemList.id中的基础功能(2k)/基础功能(4k)相对应)
noOperaTimeout 是 number 无操作超时时间， 默认5分钟 5
appliType 是 number 应用类型，2（SR共享）
成功返回示例
{
  "code": 1000,
  "message": "Success",
  "result": {
    "appliId": "1108687429323194368",
    "appliName": "king",
    "userId": "879770861261815808",
    "productId": "876868012177620992",
    "orderId": "1108687429931368448",
    "chargeType": 2,
    "appliType": 2,
    "appliPath": "20230518092737200",
    "zipFile": "1108687327049285632.zip",
    "fileSize": "21484303",
    "exeFilePath": "WindowsNoEditor/BaiYunJiChang_Demo/Binaries/Win64/BaiYunJiChang_Demo.exe",
    "exeFilePathList": "WindowsNoEditor/BaiYunJiChang_Demo/Binaries/Win64/BaiYunJiChang_Demo.exe",
    "param": "",
    "initWinSize": 0,
    "initCursorMode": 0,
    "fullScreenMode": 0,
    "screenBgColor": "",
    "startProcType": 0,
    "useGamepad": 0,
    "mobileForceLandscape": 1,
    "mobileVirtualJoystick": 1,
    "mouseZoomDirection": 1,
    "playerListToggle": 1,
    "limitMaxFps": 1,
    "touchOperateMode": "mouse",
    "syncRegions": "HDSQ-1",
    "dcs": 1,
    "playMode": 0,
    "audioInput": 0,
    "groupId": "1075453155497476096",
    "serverStandard": "2k",
    "noOperaTimeout": 5,
    "status": 1,
    "createUser": "879770861261815808",
    "createDate": "1684373281712",
    "updateUser": "879770861261815808",
    "updateDate": "1684373281712",
    "deleteFlag": 0,
    "serviceItemList": [
      {
        "id": "876869352356547789"
      },
      {
        "id": "876869513688121344"
      }
    ],
    "uploadId": "A7372A1601E748B6B0075178B000A636"
  }
}
成功返回示例的参数说明
参数名 类型 说明
code int 无
message string 无
result object 无
appliId string 无
appliName string 无
userId string 无
productId string 无
orderId string 无
chargeType string 无
appliType string 无
appliPath string 无
zipFile string 无
fileSize string 无
exeFilePath string 无
exeFilePathList string 无
param string 无
initWinSize string 无
initCursorMode string 无
fullScreenMode string 无
screenBgColor string 无
startProcType string 无
useGamepad string 无
mobileForceLandscape string 无
mobileVirtualJoystick string 无
mouseZoomDirection string 无
playerListToggle string 无
limitMaxFps string 无
touchOperateMode string 无
syncRegions string 无
dcs string 无
playMode string 无
audioInput string 无
groupId string 无
serverStandard string 无
noOperaTimeout string 无
status string 无
createUser string 无
createDate string 无
updateUser string 无
updateDate string 无
deleteFlag string 无
serviceItemList array 无
serviceItemList.id string 无
uploadId string 无
失败返回示例
复制{
"code":500
"message":"uploadId无效"
}
{
"code":500
"message":"请检查serviceItemList传值是否正确"
}
pxy_wy 2025年3月11日 17:39 收藏文档

开发者交流群

QQ群号：1011308692