向日葵管理(sl-api)

公共分类

广告

获取广告图

基本信息

Path： /advertisement

Method： GET

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是	是

Query

参数名称	是否必须	示例	备注
key	是	SUNLOGIN_HOME_BUYBANNER	广告标识
limit	否	3	广告图数量

Reponse

[
   {
      "advertisementid": 257,
      "title": "向日葵首页_搭建向日葵会议室",
      "description": "",
      "url": "http://url.oray.com/cqIJds",
      "target": "_blank",
      "medias": {
         "width": 3840,
         "height": 2160,
         "url": "//upload-cdn.oray.com/upload/help/1803/201803061623254188.jpg"
      },
      "createtime": "2018-03-02 16:54:58",
      "expiretime": null
   }
]

域名访问

主机绑定葵域名

基本信息

Path： /share/domain

Method： POST

接口描述：

主机绑定葵域名，此操作会先解绑以前绑定的葵域名，再绑定新的

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
remoteid	text	是	1665808
domain	text	是	xxx.yyy.com

修改主机默认域名访问状态

基本信息

Path： /share/:remoteid/:status

Method： PUT

接口描述：

开启默认域名访问，但该接口不绑定葵域名

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
remoteid	主机ID
status	状态	1开启，0关闭（同时关闭葵域名）

Query

参数名称	是否必须	示例	备注
remoteid	是	6587456	主机ID

检测葵域名能否注册

基本信息

Path： /share/check-domain

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
domainprefix	是	666nb	域名前缀

Reponse

{
   "msg": "长度需在5-30之间"
}

获取主机开启域名访问的信息

基本信息

Path： /shares

Method： GET

接口描述：

Request

葵域名列表

基本信息

Path： /share/domains

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
userid	否		用户ID，空则取cookie

Reponse

[
    {
      "domainname": "ccccc.xrk.top",
      "remoteid": 3244353   // 绑定的主机id，没有则为null
    }
]

主机管理

获取主机common配置

基本信息

Path： /config/common

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
remoteid	是		主机ID，多个用","分隔

Reponse

[
   {
      "remoteid": 821,
      "moduleid": 0,
      "configid": 10792385,
      "config": {
         "configid": 10792385,
         "moduleid": 0,
         "userid": 11996298,
         "name": "",
         "config": "<?xml version=\"1.0\" encoding=\"utf-8\" ?><Config><common><askForQuit>0</askForQuit><AutoClose>0</AutoClose><Autorun>1</Autorun><EnableRemoteControl>1</EnableRemoteControl><EnableRemoteWakeup>0</EnableRemoteWakeup><EnableVpn>0</EnableVpn><Language>chs</Language><Notify>0</Notify><ServiceOnly>0</ServiceOnly><Timeout>99999</Timeout><timeout>99999</timeout><autoClose>0</autoClose><autorun>1</autorun><notify>0</notify><serviceOnly>0</serviceOnly><enableRemoteControl>1</enableRemoteControl><enableVpn>0</enableVpn><Logpath>C:\\Program Files (x86)\\Oray\\SunLogin\\RemoteClient</Logpath></common></Config>",
         "isreadonly": false
      },
      "isservice": 0,
      "isstartup": 1,
      "isnotify": 0
   }
]

获取主机hostinfo配置

基本信息

Path： /config/hostinfo

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
remoteid	是		主机ID，多个用","分隔

Reponse

[
   {
      "kk": "a1",
      "hostinfo": {
         "envs": {
            "os": "Microsoft Windows 7 旗舰版",
            "target": "window"
         }
      }
   }
]

获取主机security配置

基本信息

Path： /config/security

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
remoteid	是		主机ID，多个用","分隔

Reponse

[
   {
      "remoteid": 741,
      "moduleid": 0,
      "configid": 10800469,
      "config": {
         "configid": 10800469,
         "moduleid": 0,
         "userid": 9694977,
         "name": "",
         "config": "<?xml version=\"1.0\" encoding=\"utf-8\" ?><Config><security><Autolock>0</Autolock><Blacklist></Blacklist><Enable>0</Enable><Password>QWEqwe123</Password><Switch>0</Switch><WakeUpPassword>QWEqwe123</WakeUpPassword><Whitelist></Whitelist></security></Config>",
         "isreadonly": false
      },
      "password": "QWEqwe123",
      "islock": true
   }
]

获取主机列表

基本信息

Path： /remotes

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
keyword	否		主机名关键字
tagid	否		主机标签ID
offset	否		搜索起始位置
limit	否		列表主机数量

Reponse

[
  {
    "remoteid": "23360744",
    "ownerid": 24,
    "mac": "00-00-00-00-00-00",
    "licensecode": "d604-d865-e7a2-44ff",
    "createtime": "2018-03-24 14:40:37",
    "client": null,
    "license": {
      "licensecode": "d604-d865-e7a2-44ff",
      "userid": 24,
      "remoteid": 23360744,
      "auth": "qn6PMtXw9VtlbG8AId6jbTvLmK0JhHgH",
      "isbind": true,
      "createtime": "2018-03-24 14:40:37"
    },
    "licensealias": null,
    "fastcode": null,
    "info": {
      "remoteid": 23360744,
      "name": "3",
      "pcname": null,
      "cpu": null,
      "memory": null,
      "osname": null,
      "browser": null,
      "versioncode": null,
      "version": "0",
      "memo": null,
      "description": null,
      "avatar": null,
      "baseboard": null,
      "diskdrive": null,
      "videocontroller": null,
      "networkadapter": null,
      "tagids": null,
      "configmodifiedtime": null
    },
    "status": null,
    "user": {
      "remoteid": 23360744,
      "userid": 24,
      "modules": null
    },
    "sharedomain": "h65h5rg34.xrk.top"     // 有绑定葵域名时返回值，无则null
  }
]

获取主机在线信息

基本信息

Path： /remote/wakeup-status

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
remoteid	是	234345,546567,323223	主机ID

Reponse

{
   "24280391": {
      "type": 0,
      "token": "3832343b5c64676e",
      "key": null,
      "mac": "000C294D0476",
      "password": "",
      "ip": "42.121.13.244",
      "enable": false,
      "needpwd": false,
      "needcheck": false
   },
   "27610596": {
      "type": 0,
      "token": "3832343b5c64676e",
      "key": null,
      "mac": "64006A077339",
      "password": "",
      "ip": "42.121.13.244",
      "enable": false,
      "needpwd": false,
      "needcheck": false
   },
   "27646476": {
      "type": 0,
      "token": "3832343b5c64676e",
      "key": null,
      "mac": "64006A15701D",
      "password": "",
      "ip": "42.121.13.244",
      "enable": false,
      "needpwd": false,
      "needcheck": false
   },
   "28194627": {
      "type": 0,
      "token": "3832343b5c64676e",
      "key": null,
      "mac": "F0DEF1C986D8",
      "password": "",
      "ip": "42.121.13.244",
      "enable": false,
      "needpwd": false,
      "needcheck": false
   },
   "28197381": {
      "type": 1,
      "token": "59253bc06f2070c2",
      "key": null,
      "mac": "",
      "password": "0",
      "ip": "42.121.13.244",
      "enable": false,
      "needpwd": false,
      "needcheck": false
   },
   "28207104": {
      "type": 0,
      "token": "3832343b5c64676e",
      "key": null,
      "mac": "F48E387E9201",
      "password": "",
      "ip": "42.121.13.244",
      "enable": false,
      "needpwd": false,
      "needcheck": false
   },
   "28270313": {
      "type": 0,
      "token": "3832343b5c64676e",
      "key": null,
      "mac": "000C296C25C4",
      "password": "",
      "ip": "42.121.13.244",
      "enable": false,
      "needpwd": false,
      "needcheck": false
   },
   "28291310": {
      "type": 0,
      "token": "3832343b5c64676e",
      "key": null,
      "mac": "000C2918018E",
      "password": "",
      "ip": "42.121.13.244",
      "enable": false,
      "needpwd": false,
      "needcheck": false
   },
   "28308071": {
      "type": 1,
      "token": "a2d44b74b8329b0e",
      "key": null,
      "mac": "",
      "password": "0",
      "ip": "42.121.13.244",
      "enable": false,
      "needpwd": false,
      "needcheck": false
   },
   "28308349": {
      "type": 1,
      "token": "4c9268f155fc1ec1",
      "key": null,
      "mac": "",
      "password": "0",
      "ip": "42.121.13.244",
      "enable": false,
      "needpwd": false,
      "needcheck": false
   },
   "28308552": {
      "type": 1,
      "token": "2dde0ad9c1c93ece",
      "key": null,
      "mac": "",
      "password": "0",
      "ip": "42.121.13.244",
      "enable": false,
      "needpwd": false,
      "needcheck": false
   },
   "28311160": {
      "type": 0,
      "token": "3832343b5c64676e",
      "key": null,
      "mac": "000C299ED24B",
      "password": "",
      "ip": "42.121.13.244",
      "enable": false,
      "needpwd": false,
      "needcheck": false
   },
   "28324779": {
      "type": 0,
      "token": "3832daa5e026327c",
      "key": null,
      "mac": "30363A30303A",
      "password": "",
      "ip": "42.121.13.244",
      "enable": false,
      "needpwd": false,
      "needcheck": false
   }
}

获取主机在线状态

基本信息

Path： /remote/status

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
remoteid	是	323324,324324	主机id，多个用“,”分隔

Reponse

{
   "23360744": {
      "remoteid": 23360744,
      "state": 1,
      "fastcode": "650583739",
      "ip": "117.85.22.216",
      "mainip": "114.215.168.126",
      "logintime": "2018-09-05 07:07:21",
      "remoteaddr": "https://23360744-8e3bs7ea8d772.rc03.oray.com/cgi-bin/login.cgi"
   }
}

获取主机数

基本信息

Path： /remote/summary

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
userid	否		用户ID，无则读cookie
keyword	否		关键字
tagid	否		主机标签

Reponse

{
   "count": 10
}

获取单台主机信息

基本信息

Path： /remotes/:remoteid

Method： GET

接口描述：

Request

路径参数

参数名称	示例	备注
remoteid	213234	主机ID

Reponse

{
   "remoteId": "23360744",
   "ownerId": "24",
   "mac": "00-00-00-00-00-00",
   "licenseCode": "d604-d865-e7a2-44ff",
   "createTime": "2018-03-24 14:40:37",
   "client": null
}

开机棒管理

切换开机棒帐号

基本信息

Path： /wakeups/account

Method： PUT

接口描述：

错误代码：

400201  找不到对应的开机棒

400206  SN不能为空

400207  切换帐号不存在

400208  切换帐号失败

Request

Headers

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

Body

{
   "sn": "",
   "account": "yoontyaw-001",
   "password": "xxx"
}

Reponse

{
   "code": 400206,
   "message": "SN不能为空",
   "data": null
}

获取主机绑定的开机棒

基本信息

Path： /device/remote/:remoteid

Method： GET

接口描述：

Request

路径参数

参数名称	示例	备注
remoteid		主机ID

Reponse

[
   {
      "deviceid": 11478,
      "userid": 12532915,
      "name": "开机棒",
      "sn": 3832343,
      "phsn": null,
      "mac": 0,
      "version": null,
      "productiondate": "2016-05-09 00:00:00",
      "createtime": "2016-05-26 10:59:21",
      "activedate": "2016-05-26 11:02:20",
      "isactive": null,
      "used": null,
      "servicetype": 1,
      "serviceid": 9661447
   }
]

获取开机棒数量

基本信息

Path： /device/count

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
userid	否		用户ID

Reponse

{
   "count": 2
}

获取开机设备

基本信息

Path： /wakeups

Method： GET

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Authorization	Bearer xxx	是

消息群发

删除群发消息

基本信息

Path： /message/delete

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
messageIds	是	['78','79','80']	参数为数组
isDelete	是	1	布尔值

Reponse

{
   "success": true
}

新建消息群发

基本信息

Path： /message/create

Method： POST

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
content	text	是	content
downloadTime	text	否	00:00	有则用,无则设置默认
remotes	text	是
link	text	否

Reponse

{
   "messageId": "82"
}

获取消息信息

基本信息

Path： /message/info

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
messageid	是	86

Reponse

{
   "id": 85,
   "userid": 19819779,
   "format": 0,
   "content": "ceshiceshiceshi ",
   "status": 0,
   "sendstart": "0",
   "sendend": "0",
   "expiredate": "2018-11-09 14:20:58",
   "createtime": "2018-11-08 14:20:58"
}

获取消息列表

基本信息

Path： /message/list

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
userid	否	19819779	有则用,没有则从cookie读

Reponse

[
   {
      "id": "83",
      "userid": "19819779",
      "format": "0",
      "content": "asdasdsad",
      "status": "0",
      "sendstart": null,
      "sendend": null,
      "expiredate": "2018-11-09 11:44:37",
      "createtime": "2018-11-08 11:44:37"
   },
   {
      "id": "84",
      "userid": "19819779",
      "format": "0",
      "content": "新的测试数据",
      "status": "0",
      "sendstart": null,
      "sendend": null,
      "expiredate": "2018-11-09 11:57:46",
      "createtime": "2018-11-08 11:57:46"
   }
]

文件分发

删除任务

基本信息

Path： /filetransfer/delete

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
taskids	是	'123,124,125'	多个id用逗号 隔开

Reponse

true

新建文件分发任务

基本信息

Path： /filetransfer/create

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
userid	否		有则用,没有则读cookie
name	是
isReplace	是	1
downloadstartH	否		设定用户下载的开始时间
downloadendH	否		设定用户下载的结束时间段
speed	否		下载速度限制 默认无
remoteIds	是	123,4532,432,2134,	多个主机id用逗号隔开
savepath	否		没有就设为空
isexecute	是

Reponse

{
   "id": "128",
   "userId": "12532915",
   "name": "1.txt",
   "isReplace": "1",
   "speed": "0",
   "status": "0",
   "downloadStart": "13:47",
   "downloadEnd": "14:47",
   "expireDate": "2018-11-19 14:47:41.000000",
   "createTime": "2018-11-12 14:47:41",
   "savePath": "",
   "successNum": "0",
   "failedNum": "0",
   "fileSize": "0",
   "isExecute": "1"
}

新建文件分发文件

基本信息

Path： /filetransfer/createFile

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
userid	否
transfertaskid	是	148	新建任务成功之后返回的taskid
file[fileid]	是	f1f492de1d2fee050eb16ed994a24178
file[status]	是	2
filesize	是	123412
filename	是	1.jpg

Reponse

true

获取任务列表

基本信息

Path： /filetransfer/list

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
userid	否	1123422	有则用 没有则读cookie

Reponse

[
   {
      "id": "79",
      "userId": "12532915",
      "name": "1.txt",
      "isReplace": "1",
      "speed": "0",
      "status": "0",
      "downloadStart": "11:15",
      "downloadEnd": "12:15",
      "expireDate": "2018-11-19 12:15:25.000000",
      "createTime": "2018-11-12 12:15:25",
      "savePath": "",
      "successNum": "0",
      "failedNum": "0",
      "fileSize": "0",
      "isExecute": "1"
   },
   {
      "id": "80",
      "userId": "12532915",
      "name": "1.txt",
      "isReplace": "1",
      "speed": "0",
      "status": "0",
      "downloadStart": "11:16",
      "downloadEnd": "12:16",
      "expireDate": "2018-11-19 12:16:01.000000",
      "createTime": "2018-11-12 12:16:01",
      "savePath": "",
      "successNum": "0",
      "failedNum": "0",
      "fileSize": "0",
      "isExecute": "1"
   }
]

获取详细信息

基本信息

Path： /filetransfer/info

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
taskid	是	118

Reponse

{
   "id": "118",
   "userId": "12532915",
   "name": "1.txt",
   "isReplace": "1",
   "speed": "0",
   "status": "0",
   "downloadStart": "13:42",
   "downloadEnd": "14:42",
   "expireDate": "2018-11-19 14:42:53.000000",
   "createTime": "2018-11-12 14:42:53",
   "savePath": "",
   "successNum": "0",
   "failedNum": "0",
   "fileSize": "0",
   "isExecute": "1"
}

邮件订阅

删除短信订阅记录

基本信息

Path： /log/deleteSms

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
smsid	是		短信记录id

Reponse

true

删除邮件记录

基本信息

Path： /log/deleteEmail/

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
subscibeid	是		邮件记录的id

Reponse

true

新建订阅短信记录

基本信息

Path： /log/createSms

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
code	是		短信验证码
mobile	是		手机号码
email	是		邮箱
type	是		订阅类型
remoteids	是		主机列表

Reponse

true

新建邮件订阅

基本信息

Path： /log/createEmail

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
email	是	******@163.com
code	是	123456	验证码
frequency	是	mouth	mouth/week

Reponse

true

订阅短信报表记录

基本信息

Path： /log/sms

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
userid	是		有则用没有则读cookie

Reponse

[
   {
      "id": "16",
      "userId": "19819779",
      "mobile": "",
      "email": null,
      "type": "login",
      "remoteIds": "12,3,4,14,24,124",
      "createTime": "2018-11-19 14:19:09"
   },
   {
      "id": "17",
      "userId": "19819779",
      "mobile": "13100001111",
      "email": null,
      "type": "login",
      "remoteIds": "12,3,4,14,24,124",
      "createTime": "2018-11-19 14:19:52"
   },
   {
      "id": "18",
      "userId": "19819779",
      "mobile": "13100001111",
      "email": null,
      "type": "login",
      "remoteIds": "111112,32222222,3333333333333,1444444,21114,144444424",
      "createTime": "2018-11-19 14:20:17"
   }
]

邮件订阅列表

基本信息

Path： /log/list

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
userid	否		有则用,没有则读cookie

Reponse

[
   {
      "id": "7",
      "userId": "19819779",
      "email": "zw204801@163.com",
      "frequency": "month",
      "createTime": "2018-11-16 16:04:47"
   }
]

云监控

开通云监控

基本信息

Path： /monitor

Method： POST

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
remoteid	text	是	3124345	主机ID
account	text	否	oray	PC用户名，选择windows用户验证方式时才传
password	text	是	oray.com	1、windows验证方式时传windows密码，2、客户端访问密码
type	text	是	1	windows用户验证方式：1；访问密码验证：0

Reponse

{
    "msg": "开启云监控失败"   // 失败时返回的错误信息
}

更新云监控配置

基本信息

Path： /monitor

Method： PUT

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
remoteid	text	是	4234323	主机ID
status	text	是	1	云监控状态，1开启，0关闭
desktop	text	否	1	监控桌面
framerate	text	否	1	帧速率，0：1帧/秒；1：2帧/秒
timetype	text	否	0	监控时间：1自定义时间，0主机在线时
times	text	否	15728655,16777215,16777215,15728643,16769023,16740367,16777215	自定义时间段，7个时间段，用“,”隔开

获取主机云监控信息

基本信息

Path： /monitors/:remoteid

Method： GET

接口描述：

Request

路径参数

参数名称	示例	备注
remoteid	22547817	主机ID

Reponse

{
  "remoteid": 22547817,
  "type": 0,                        // 监控类型，0桌面，1摄像头
  "status": 1,                      // 开启状态
  "thumbnail": "22547817-1515032026.jpg",
  "starttime": "2017-12-30 12:15:26",
  "endtime": "2018-01-04 10:04:02",
  "isonline": null,                 // 主机在线状态
  "desktop": 0,                     // 监控的桌面
  "framerate": 0,                   // 帧速率
  "motiondetection": 0,             // 开启移动侦测
  "times": [],                      // 监控时段
  "timetype": 0,                    // 监控时段类型，0设备在线时，1自定义
  "desktops": [0, 1, 2]             // 桌面列表
}

获取开通云监控的主机

基本信息

Path： /monitors

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
remoteid	是	12345,236546	主机ID，多个ID用英文“,”分隔

Reponse

[
  {
    "remoteid": 22547817,
    "type": 0,
    "status": 1,     // 云监控开启状态，1开启，0关闭
    "thumbnail": "22547817-1515032026.jpg",
    "starttime": "2017-12-30 12:15:26",
    "endtime": "2018-01-04 10:04:02",
    "isonline": 0    // 主机在线状态，1在线，0离线
  }
]

获取用户云监控服务

基本信息

Path： /monitor/get-service

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
userid	否	18520877	如不传，则读取cookie

Reponse

{
   "serviceId": 14194116,
   "userId": 18520877,
   "productId": 13041,
   "isValid": 1,
   "isDelete": 0,
   "createTime": "2017-09-27 23:55:58",
   "expireDate": "2018-12-29 00:00:00",
   "name": "向日葵软件云监控7天回放"
}

获取用户已用云监控数量

基本信息

Path： /monitor/summary

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
userid	否	4325435	如不传，则读取cookie

Reponse

{
   "count": 0
}

主机共享

取消主机共享

基本信息

Path： /shareremote

Method： DELETE

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
shareuserid	text	是	54035
remoteid	text	是	22104678

开启主机共享

基本信息

Path： /shareremote

Method： POST

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
accounts	text	是	123123123	用回车隔开
remoteid	text	是	22104678
model	text	是	all
istag	text	否		选中为1 不选中为0

根据主机ID获取共享记录

基本信息

Path： /shareremote/remote

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
remoteid	是	818911

Reponse

[
    {
        "remoteid": 29103215,
        "userid": 15834567,   // 被共享帐号的id
        "hostmodel": "desktop,desktopview,camera,file,cmd-ssh,remote",
        "tagids": [],     // 共享的标签id
        "info": null,     // 主机信息
        "account": "vp-yoontyaw-001"   // 被共享帐号的名称
    }
]

根据用户ID获取共享记录

基本信息

Path： /shareremote/user

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
userid	否

Reponse

[
   {
      "remotes": [
         {
            "remoteid": 27648551,
            "userid": 15834567,
            "hostmodel": "desktop,desktopview,camera,file,cmd-ssh,remote",
            "tagids": "14765",
            "info": {
               "remoteid": 27648551,
               "name": "GZ-1153",
               "pcname": "GZ-1153",
               "cpu": "Intel(R) Pentium(R) CPU G3240 @ 3.10GHz",
               "memory": "8108MB",
               "osname": "Microsoft Windows 10",
               "browser": null,
               "versioncode": "15686",
               "version": "9.8.1.15686",
               "memo": null,
               "description": "",
               "avatar": null,
               "baseboard": "Dell Inc. 0T1D10       ",
               "diskdrive": "SanDisk SSD PLUS 120 GB",
               "videocontroller": "Intel(R) HD Graphics",
               "networkadapter": "Hyper-V Virtual Ethernet Adapter",
               "tagids": "14765",
               "configmodifiedtime": 1548663999
            }
         }
      ],
      "account": "vp-yoontyaw-001",
      "userid": 15834567
   }
]

主机标签

获取标签

基本信息

Path： /tags/:tagid

Method： GET

接口描述：

Request

路径参数

参数名称	示例	备注
tagid

Reponse

[
   {
      "tagid": 15807,
      "userid": 24,
      "bgcolor": "#58a8b4",
      "name": "ddd",
      "orderid": 2,
      "remotenum": 1,
      "createtime": "2018-12-11 13:51:42"
   },
   {
      "tagid": 15806,
      "userid": 24,
      "bgcolor": "#729c3b",
      "name": "fsdf",
      "orderid": 1,
      "remotenum": 1,
      "createtime": "2018-12-11 13:45:27"
   }
]

主机开关机计划

获取主机开关机计划

基本信息

Path： /powerplans/:remoteid

Method： GET

接口描述：

Request

路径参数

参数名称	示例	备注
remoteid

Reponse

{
    // 关机计划
    "shutdown": {
        "repeattype": 0,     //  0 不重复，1 每天，2 按周天
        "devicetype": 1,     // 设备类型，1 开机棒，2 插座
        "timestamp": 1550152800,   // 开关机重复类型为“不重复”时有用，时间戳
        "nexttime": 1550152800,    // 下次开/关机时间戳
        "date": "2019-02-14",      // 日期，repeattype 为0时有用
        "hour": "22",              // 时，repeattype 为1时有用
        "min": "00"                // 分，repeattype 为1时有用
    },
    // 开机计划
    "poweron": {
        "repeattype": 2,
        "devicetype": 1,
        "timestamp": 1550545200,
        "nexttime": 1550545200,
        "rules": [
            {
                "repeatvalue": 2,  // repeatvalue 重复值（与运算）：暂时只供周天重复用 1 2 4 8 16 32 64 代表周一到周日
                "week": 2,         // 同上
                "hour": "11",
                "min": "00"
            }
        ]
    }
}

用户服务

获取付费用户服务

基本信息

Path： /services/:type

Method： GET

接口描述：

Request

路径参数

参数名称	示例	备注
type	payed	payed：付费服务；desktop：云桌面服务

Query

参数名称	是否必须	示例	备注
userid	否	123456	用户id

Reponse

[
    {
        "serviceid": 9191087,
        "userid": 12532915,
        "productid": 310003,
        "amount": 60,
        "isvalid": true,
        "isdelete": false,
        "createtime": "2016-03-23 11:16:07",
        "expiredate": "2019-07-02 00:00:00",
        "product": {
            "productid": 310003,
            "name": "向日葵软件旗舰版"
        },
        "csuser": null,    // 独立服务器管理子帐号
        "items": [         // 配件
            {
                "id": 123,
                "key": "SLRC-CHANNEL-LIMIT",
                "quantity": 3
            }
        ],
        "channel": 3   // 通道数
    }
]

获取用户服务

基本信息

Path： /services

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
userid	是	12532915,12532915	用户ID，多个用','分隔

Reponse

[
    {
        "serviceid": 9191087,
        "userid": 12532915,
        "productid": 310003,
        "amount": 60,
        "isvalid": true,
        "isdelete": false,
        "createtime": "2016-03-23 11:16:07",
        "expiredate": "2019-07-02 00:00:00",
        "product": {
            "productid": 310003,
            "name": "向日葵软件旗舰版"
        },
        "csuser": null,    // 独立服务器管理子帐号
        "items": [         // 配件
            {
                "id": 123,
                "key": "SLRC-CHANNEL-LIMIT",
                "quantity": 3
            }
        ],
        "channel": 3   // 通道数
    }
]

园丁计划

获取园丁信息

基本信息

Path： /gardeners/:userid

Method： GET

接口描述：

Request

路径参数

参数名称	示例	备注
userid		用户ID

Reponse

{
    "gardenerid": 1,
    "userid": 12500512,
    "code": "BcFaAfBcJfI",                // 活动推广码
    "couponcode": "4808072044",           // 服务兑换码
    "status": 1,                          // 状态，1正常，2冻结
    "consumeamount": 0,                   // 消费人数
    "consumesum": 0,                      // 消费总额
    "regnumber": 4,                       // 注册人数
    "actregnumber": 3,                    // 有效注册人数
    "registerbounty": 6,                  // 新注奖励
    "promotionbounty": 0,                 // 推广奖励
    "drawnamount": 8,                     // 已废弃
    "paidamount": 0,                      // 已支付金额
    "unpaidamount": 2,                    // 未支付金额
    "agreementstartdate": null,           // 合同开始日
    "agreementexpiredate": null,          // 合同到期日
    "address": null,                      // 地址
    "bankno": null,                       // 银行卡号
    "bankname": null,                     // 银行名称
    "payee": null,                        // 收款人
    "updatetime": "2019-06-29 13:10:42",  // 更新时间
    "createtime": "2019-06-27 10:42:12",  // 创建时间
    "cacoupon": {
        "couponid": 3177,                 // 兑换码id
        "code": "4808072044",             // 兑换码
        "endtime": "2019-12-30 00:00:00", // 兑换码有效时间
        "starttime": "2019-06-26 00:00:00"
    },
    "isexpired": true,                    // 合同是否超期
    "realname": {
        "contact": "网域科技是",          // 实名认证联系人
        "mobile": "18217440106",          // 实名手机号
        "idnum": "333333a44",             // 实名身份证号
        "isencrypted": 1                  // 是否加密
    },
    "isagreement": false,                 // 是否签合同
    "startdate": "2019年06月29日",        // 新签合同，显示的开始日期
    "expiredate": "2020年06月29日"        // 新签合同，显示的到期日
}

获取园丁客户

基本信息

Path： /gardeners/consumers

Method： GET

接口描述：

Request

Reponse

[
    {
        "consumerid": 19,                      // 客户id
        "gardenerid": 1,                       // 园丁id
        "userid": 25522173,                    // 用户id
        "account": "yoontyaw-007",             // 帐号名
        "isactive": false,                     // 是否活跃客户
        "isnew": true,                         // 是否新注
        "hadconsume": false,                   // 是否消费
        "activetime": null,                    // 活跃时间
        "createtime": "2019-06-28 15:40:32",   // 创建时间
        "user": {
            "userid": 25522173,
            "account": "yoontyaw-007    "
        }
    }

]

开发者相关

应用（SDK）验证

基本信息

Path： /app/login

Method： POST

接口描述：

错误代码

error
parameter/missing_required_parameter	缺少必要参数，appid, nonce, signature（statuscode 400）
parameter/signature_verify_fail	签名校验失败（statuscode 403）
app/app_expired	APP 已过期（statuscode 403）

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
X-AppID	asdfkljasdflkjwer	是		应用ID
X-Nonce	wasdf123asdf1234	是		随机串
X-Signature		是		md5(appid + nonce + secret)

Reponse

{
	"app": {
		"appid": "5120",
		"name": "Young",
		"expiretime": "2020-11-30 00:00:00",
		"modules": [{
			"module": "desktop_view",
			"name": null,
			"avaliable": "0"
		}, {
			"module": "desktop",
			"name": null,
			"avaliable": "0",
			"configure": {
				"chat": true,
				"sound": true,
				"record": true,
				"watermark": true,
				"screenshot": true,
				"whiteboard": true,
				"blackscreen": true,
				"shortcut_ctrl": true,
				"forbidmousekey": true
			}
		}],
		"platforms": [{
			"platform": "windows",
			"configure": {
				"max_version": "3.0.0",
				"min_version": "3.0.0"
			}
		}]
	},
	"server": {
		"address": "PHSRC:\/\/slp2p-embed01.oray.net:4118;PHSRC_HTTPS:\/\/slp2p-embed01.oray.net:443;",
		"license": "SHA1:adbwwsev;+VDnbbjhzPLPRhzty3dRNDwFmd0="
	}
}

坐席管理

坐席列表

基本信息

Path： /seats

Method： GET

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Authorization	Bearer xxxxxxxxx	是

Query

参数名称	是否必须	示例	备注
name	否		坐席名称
mac	否		mac地址
ip	否		坐席的ip
page	否	1
pagesize	否	1	默认20

Reponse

{
  //数据数组
  "data": [
    {
      //坐席id
      "seatid": 9,
      //用户id
      "userid": 12532915,
      //客户端id
      "clientid": "",
      //坐席标识，用户可见的唯一标识，登录作为帐号使用
      "seatidentity": "12532915:2497",
      //登录密码
      "password": "PvMCfo/H+QTd4JaFPwjudu++/uSIPIrjkieoGQ/QxFV1H6Lb5DrI3V9MNL+CU3sx",
      //坐席名称
      "name": "test_seat",
      //客户端Mac
      "mac": "",
      //客户端IP
      "ip": null,
      //验证手机号
      "mobile": "13666666677",
      "createtime": "2020-09-28 14:35:53",
      //是否在线
      "isonline": false,
      //所属账号
      "account": "oraytest011     ",
      //星标数量
      "like": 0
    }
  ],
  //当前页
  "currentpage": 1,
  //总页数
  "totalpage": 3,
  //总数据量
  "count": 3,
  //在线坐席数
  "online": 0, 
  //登录方式 1,账号登录 2,坐席id登录
  "logintype":1,
    //可创建坐席id数
  "idamount":0
}

坐席创建

基本信息

Path： /seats

Method： POST

接口描述：

Request

Headers

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

Body

{
   "name": "test",
   "clientid": "0647f65d-e6d8-49eb-a73f-a49b27a5426e",
   "mac": "64-00-6A-21-A5-83"
}

坐席删除

基本信息

Path： /seats/:seatid

Method： DELETE

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
seatid

坐席密码-重置

基本信息

Path： /seats/password/:seatid

Method： PUT

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
seatid		坐席id

Query

参数名称	是否必须	示例	备注
newpassword	是		新密码-md5加密
compassword	是		新密码确认-md5加密

坐席强制下线

基本信息

Path： /seats/:clientid/authorization

Method： DELETE

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
clientid

坐席日志

基本信息

Path： /seats/logs

Method： GET

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer xxxxxxx

Query

参数名称	是否必须	示例	备注
starttime	是	2020-03-20
endtime	是	2020-03-21
clientid	否	018906b4-466e-4507-a9b4-349f5f0ea1f9
mac	否

Reponse

{
    "logs": [
    	{
    		"userid": 904448,
    		"event": "seat_online",    // seat_online  上线; seat_offline  下线; file  远程文件; view  远程控制
    		"controlinfo": {
				"seatname": "xxx",                                          // 坐席名称
				"pcname": "GZ-1173",                                        // 计算机名
				"os": "Windows",                                            // 主控系统
				"version": "10.2.3.456",                                    // 软件版本
				"clientid": "52795c2d-7995-496c-aa1f-cf40af2a6c1c",         // 主控clientid
				"ip": "127.0.0.1"                                           // 坐席ip（稍后加上）
			},                                                           
    		"controlip": "192.168.30.75",                                   // 坐席ip （稍后废掉）
			"clientinfo": {
				"ip": "59.42.207.1",                                        // 主机ip
				"pcname": "GZ-1173",                                        // 计算机名
				"version": "10.3.0.26482",                                  // 软件版本
				"name": "Company`s computer",                               // 主机名
				"os": "Windows"                                             // 系统
			}, 
    		"starttime": "123456789",  // 开始时间，时间戳
    		"endtime": "123456789"     // 结束时间，时间戳
    	}
    ],
    "currentpage": 1,           // 当前页
    "totalpage": 10,            // 总页数
    "count": 200                // 总记录数
}

坐席星标-列表

基本信息

Path： /seats/like

Method： GET

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer xxx

Query

参数名称	是否必须	示例	备注
seat	否		坐席id/坐席名称
like	否		客户识别码/备注名
seatid	否		坐席标识

Reponse

[
   {
      "id": "37",
      "userid": "12532915",
      "fastcode": "123434df546",
      "seatid": "supp160572",
      "memo": "423",
      "os": null,
      "seatname": "test1",
      "latesttime": null
   },
   {
      "id": "36",
      "userid": "12532915",
      "fastcode": "12345344812",
      "seatid": "12532915:1727",
      "memo": "323",
      "os": null,
      "seatname": "test001",
      "latesttime": null
   }
]

坐席星标-删除

基本信息

Path： /seats/like/:seatid/

Method： DELETE

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
seatid		坐席id

坐席更新

基本信息

Path： /seats/:seatid

Method： PUT

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
seatid		坐席id

Query

参数名称	是否必须	示例	备注
clientid	否		客户端id,存在才传参
name	否		坐席名,需要更改才传参
mobile	否		手机号,需要更改才传参

坐席服务

基本信息

Path： /seats/product

Method： GET

接口描述：

Request

坐席注册-新版

基本信息

Path： /sl-api.oray.com/seats/register

Method： POST

接口描述：

Request

Headers

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

Query

参数名称	是否必须	示例	备注
password	是		密码-MD5
mobile	是		手机号
name	是		坐席名称

Body

{
	"password": "e10adc3949ba59abbe56e057f20f883e"   // MD5密码
}

Reponse

{
	"seatidentitty": "12500512:9840"  // 坐席id
}

坐席远控-记录

基本信息

Path： /seats/history

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
fastcode	否		被控快码
page	否
pagesize	否
seatidentity	否	supp545454	坐席标识
starttime	是	2020-10-01
endtime	是	2020-10-31
event	否	note	记录过滤类型, 星标客户远控记录传参

Reponse

{
    "data": [
        {
            "historyid": 7,
            "userid": 12532915,
            "seatidentity": "12500512:7939",  //坐席id
            "seatname": null,  //坐席备注名
            "fastcode": "168520365",  //被控快码
            "event": "view", //事件名
            "starttime": null, //开始时间
            "endtime": null, //结束时间
            "memo": "",  //备注
            "slccinfo":{
                "slcc_ip":"116.235.162.148",
                "slcc_version":"5.1.0.32847"
            }, //主控端信息
            "slrcinfo":{
                "slrc_ip":"116.235.162.148",
                "slrc_version":"11.0.0.32806",
                "slrc_osname":"windows",
                "slrc_pcname":"WIN-JJ7LM4M9QB2"
            },  //被控信息
            "slrcname": null,  //被控备注名
            "createtime": "2020-10-12 21:11:25"  //创建时间
        }
    ],
    "currentpage": 1,
    "totalpage": 1,
    "count": 1
}

安全保护-信息

基本信息

Path： /seats/security

Method： GET

接口描述：

Request

Reponse

//用户首次进入,数据表无数据,后端默认创建一条并返回id
{
  "securityid": 23, 
  "ismobile": 1,  //首次进入为0
  "ismac": 1,  //首次进入为0
  "macs": [
    {
      "macid": 10,
      "mac": "123123_dfefef:dfsdfsdf"
    },
    {
      "macid": 9,
      "mac": "234-23fd-2342sdd-fdf"
    }
  ]  //首次进入为空数组
}

安全保护-更新

基本信息

Path： /seats/security/:securityid

Method： PUT

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
securityid	1	安全保护配置id

Query

参数名称	是否必须	示例	备注
ismobile	否	0	是否开启手机验证 0否 1是
ismac	否	0	是否开启Mac地址过滤 0,否 1,白名单 2,黑名单 不开启则返回数据macs为空数组
isclose	否	1	是否关闭坐席id登录方式 1是

安全保护-设置-Mac-删除

基本信息

Path： /seats/mac/:macid

Method： DELETE

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
macid	5,6,7	mac地址id 支持多id删除,用,号间隔macid

安全保护-设置-Mac-添加

基本信息

Path： /seats/mac

Method： POST

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
mac	是		mac地址
mactype	是		mac过滤类型 1,白名单 2,黑名单

独立服务器周报

周报-周下拉

基本信息

Path： /weekly/range

Method： GET

接口描述：

Request

Reponse

{
   "1": "2021-01-11~2021-01-17",
   "2": "2021-01-04~2021-01-10",
   "3": "2020-12-28~2021-01-03",
   "4": "2020-12-21~2020-12-27",
   "5": "2020-12-14~2020-12-20",
   "6": "2020-12-07~2020-12-13",
   "7": "2020-11-30~2020-12-06"
}

周报-订阅配置-更新

基本信息

Path： /weekly/subscribe

Method： PUT

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
issubscribe	是	1	是否订阅 0,否 1,是
email	否	123@163.com	订阅邮箱 当issubscribe为1时才传参
code	否	DFDGWCD	邮箱验证码 当issubscribe为1时才传参

Body

{
"issubscribe":"0", //必需  0,否 1,是
"email":"123@163.com" //非必需
}

周报-订阅配置-获取

基本信息

Path： /weekly/subscribe

Method： GET

接口描述：

Request

Reponse

{
  "configid": 3,
  "userid": 12532915,
  "issubscribe": 0,  //是否订阅 0,否 1,是
  "email": "", //订阅邮箱
  "createtime": "2020-11-16 11:37:11"
}

周报-订阅配置-验证码-发送

基本信息

Path： /weekly/verify

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
email	是	123@163.com	邮箱

周报-记录-详细

基本信息

Path： /weekly/record

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
week	是	2020-11-16~2020-11-22	周开始结束日期

Reponse

{
   "weeklyid": 3,
   "userid": 12564122,
   "online": {
      "date": [
         "2020/12/07",
         "2020/12/08",
         "2020/12/09",
         "2020/12/10",
         "2020/12/11",
         "2020/12/12",
         "2020/12/13"
      ],
      "value": [
         84,
         50,
         32,
         32,
         19,
         158,
         213
      ],
      "img": "cacf08326b787ec21755f07b7250d82d.png"
   },
   "link": {
      "date": [
         "2020/12/07",
         "2020/12/08",
         "2020/12/09",
         "2020/12/10",
         "2020/12/11",
         "2020/12/12",
         "2020/12/13"
      ],
      "value": [
         562,
         1540,
         1203,
         785,
         964,
         4510,
         596
      ],
      "img": "8d2ce75c7f706911bb56edc10b968885.png"
   },
   "monitor": {
      "date": [
         "2020/12/07",
         "2020/12/08",
         "2020/12/09",
         "2020/12/10",
         "2020/12/11",
         "2020/12/12",
         "2020/12/13"
      ],
      "value": [
         "16.15",
         "15.04",
         "11.75",
         "76.67",
         "94.15",
         "44.05",
         "58.26"
      ],
      "img": "dc21e5e1ce6417b52e3ab3f16ac10465.png"
   },
   "startday": "2020-12-07",
   "endday": "2020-12-13",
   "createtime": "2020-12-09 14:30:04"
}

云键盘

列表

基本信息

Path： /keyboard/list

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
keyboardname	否	LOL	键盘名称
type	否	1	键盘分类 0,角色扮演 1, 动作, 2,射击 3,策略 4,赛车, 5,其他, 不传参显示全部
equipment	否	1	设备 1,phone 2,pad
sort	否	likes	排序 likes,点赞 used,使用 collect,收藏
page	否	1	页码 默认1
pagesize	否	10	页条数 默认20

Reponse

{
    //当前页码
    "page": 1,
    //总页数
    "totalpage": 11,
    //总数据数
    "totallist": 11,
    "list": [
        {
            //键盘id
            "keyboardid": "15",
            //用户id
            "userid": "12564122",
            //分类id
            "typeid": "0",
            //键盘名称
            "name": "蝙蝠侠 阿卡姆之城3",
            //键位绘制图
            "img": "https://upload.oray.com/slkeyboard.php?keyboardimg=Ni82ZGUwNDAwY2RmZmU1OWZjMzBmOWZmNGU1YjU1ZmE4NA==",
            //点赞数
            "likes": "0",
            //收藏数
            "collect": "0",
            //使用数
            "used": "2",
            //是否官网 0,否 1,是
            "isofficial": "0",
            //适配设备 1,phone 2,pad
            "equipment": "1",
            //是否分享
            "isshare": "1",
            //创建时间
            "createtime": "2021-04-13 14:20:23",
            //是否已点赞 0,否 1,是
            "islike": "0",
            //是否使用过 0,否 1,是
            "isused": "1",
            //是否已收藏 0,否 1,是
            "iscollect": "0",
            //是否自我创建 0,否 1,是
            "isself": "0",
            //分享id
            "shareid": "80",
            //分类背景图
            "background": "http://backend.orayimg.com/sunlogin/img/cloudkeyboard/default.png"
        }
    ]
}

收藏

基本信息

Path： /keyboard/collect

Method： POST

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
keyboardid	是

Reponse

/**
 * 状态码204 为处理成功
 * code: 400604 非游戏用户,无法收藏
*/

{
  "code": 400603,
  "message": "已收藏",
  "data": null
}

点赞

基本信息

Path： /keyboard/like

Method： POST

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
keyboardid	是

Reponse

/**
 * 状态码204 为处理成功
*/

{
    "code": 400602,
    "message": "已点赞",
    "data": null
}

详情

基本信息

Path： /keyboard/info

Method： GET

接口描述：

Request

Query

参数名称	是否必须	示例	备注
keyboardid	是		键盘id

Reponse

{
    //键盘id
    "keyboardid": "15",
    //用户id
    "userid": "12564122",
    //分类id
    "typeid": "0",
    //键盘名称
    "name": "蝙蝠侠 阿卡姆之城3",
    //键位绘制图
    "img": "https://upload.oray.com/slkeyboard.php?keyboardimg=Ni82ZGUwNDAwY2RmZmU1OWZjMzBmOWZmNGU1YjU1ZmE4NA==",
    //点赞数
    "likes": "0",
    //收藏数
    "collect": "0",
    //使用数
    "used": "2",
    //是否官网 0,否 1,是
    "isofficial": "0",
    //适配设备 1,phone 2,pad
    "equipment": "1",
    //是否分享
    "isshare": "1",
    //创建时间
    "createtime": "2021-04-13 14:20:23",
    //是否已点赞 0,否 1,是
    "islike": "0",
    //是否使用过 0,否 1,是
    "isused": "1",
    //是否已收藏 0,否 1,是
    "iscollect": "0",
    //是否自我创建 0,否 1,是
    "isself": "0",
    //分享id
    "shareid": "80",
    //分类背景图
    "background": "http://backend.orayimg.com/sunlogin/img/cloudkeyboard/default.png"
}

直播

维持浏览器直播在线

基本信息

Path： /live/ping/:uid

Method： GET

接口描述：

Request

路径参数

参数名称	示例	备注
uid		唯一id，/live/:liveid 接口返回

获取直播流

基本信息

Path： /live/:liveid

Method： GET

接口描述：

response statuscode：

400504  直播间不存在

400505  直播已结束

400506  直播间密码错误

Request

路径参数

参数名称	示例	备注
liveid		直播id

Query

参数名称	是否必须	示例	备注
psw	是		直播密码（md5）

Reponse

{
	"live_domain": "live.sunlogin.oray.com",   // 播流域名
	"appname": "live",                         // 应用名
	"streamname": null,                        // 流名称
	"auth_key": "xxx"                          // 鉴权串
}

获取直播间状态

基本信息

Path： /live/status/:liveid

Method： GET

接口描述：

response statuscode：

400701  直播间不存在

400702  直播已结束

400703  直播间密码错误

Request

路径参数

参数名称	示例	备注
liveid

Reponse

{
	"status": 1,    // 直播状态：1直播中，0已结束
	"needauth": 0   // 直播间验证：1需要密码，0不需要
}

进入/退出直播间

<a id=进入/退出直播间>

基本信息

Path： /live/room/:action/:liveid

Method： PUT

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
cookie		是		必须，接口里调用客户端rpc要用到，取oray.com的即可

路径参数

参数名称	示例	备注
action	entry	进入 entry，退出 leave
liveid		直播id

客户端访问接口

免费领取安卓授权

基本信息

Path： /client/services/claimandroid

Method： GET

接口描述：

接口域名：as-api.aweray.net

action:

    login : 未登录

    serviced : 用户已是付费/用户已领取服务（未过期）

    expired : 用户已领取服务（过期）

Request

Reponse

{
   "success": false,
   "data": {
      "had": 1,
      "action": "expired",
      "remotecounts": 0
   }
}

服务配件

IT资产试用弹窗显示规则

基本信息

Path： /feature/popups

Method： GET

接口描述：

Request

Reponse

{
    // 是否隐藏弹窗
    "is_hidden": false,
    // 是否已领取
    "is_receive": true,
    // 配件是否过期
    "is_expired": true,
    // 是否默认配件, 针对企业+服务
    "is_default": false,
    // 是否可领取试用配件, 针对行业版以下服务&主机数条件满足
    "is_tryout": false,
    // 可试用天数
    "tryout_days": 0,
    // 主机数
    "remotes": 1
}

IT资产试用弹窗隐藏

基本信息

Path： /feature/popups

Method： POST

接口描述：
undefined

Request

IT资产试用领取

基本信息

Path： /feature/receive

Method： POST

接口描述：
undefined

Request

留资页接口

提交信息接口

基本信息

Path： /service/experience

Method： POST

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
company_name	text	是	上海贝锐信息科技股份有限公司	公司名称
industry	text	是	软件服务	行业
mobile	text	是	159xxxxxxxx	联系手机号
contact	text	是	老冯	联系人名称
description	text	是	1234	备注
referral_id	text	是		推广ID
scale	text	是	50人	公司规模
popularize_url	text	是	https://www.baidu.com	来源推广链接
brand	text	否		默认 3 向日葵
email	text	否		默认 -
title	text	否		默认 -
e_type	text	否		默认 预约演示
code	text	是		手机验证码
activity	text	是		activity由前端控制 看需求 a页面进来时 SL_LEAD b进来是 SL_ENT 后面可能还有c进来 SL_XXX

Reponse

ok

更新留资页信息接口

基本信息

Path： /service/experience

Method： PUT

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
mobile	text	是	159xxxxxxxx	联系手机号
contact	text	是	老冯	联系人名称
code	text	是		手机验证码
activity	text	是		activity由前端控制 看需求 a页面进来时 SL_LEAD b进来是 SL_ENT 后面可能还有c进来 SL_XXX
id	text	是
source	text	是
description	text	是

Reponse

ok

获取留资页信息接口

基本信息

Path： /service/experience

Method： GET

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
mobile	是		手机号
activity	是		activity由前端控制 看需求 a页面进来时 SL_LEAD b进来是 SL_ENT 后面可能还有c进来 SL_XXX

Reponse

ok

微信登陆

微信回调地址

基本信息

Path： /qrcode/wechat

Method： GET

接口描述：

客户端登陆请求公共接口http://yapi.orayer.com:3000/project/51/interface/api/1229

头部记得带

authorize.wechat.headerkey = "X-Authorize-App"
X-Authorize-App = "sunloginpc"

Request

Query

参数名称	是否必须	示例	备注
code	是	031iOoll2FxLe94AVOnl2S32eE1iOols
state	是	dfvijMLNcONUglfH

Reponse

031iOoll2FxLe94AVOnl2S32eE1iOols

获取授权链接

基本信息

Path： /qrcode/link

Method： GET

接口描述：

请求测链接会自动跳转到微信二维码

用户扫码后会回调到https://sl-api.oray.com/qrcode/wechat?code=031iOoll2FxLe94AVOnl2S32eE1iOols&state=dfvijMLNcONUglfH

输出

031iOoll2FxLe94AVOnl2S32eE1iOols

客户端登陆请求公共接口http://yapi.orayer.com:3000/project/51/interface/api/1229

头部记得带

authorize.wechat.headerkey = "X-Authorize-App"
X-Authorize-App = "sunloginpc"

Request

Query

参数名称	是否必须	示例	备注
type	是	wechatweb

新服务升级

升级-前置查询

基本信息

Path： /upgrade/front

Method： GET

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer xxx

Reponse

{
    // 帐号ID
    "userid": 123456789,
    // 产品服务ID
    "product_id": 310007,
    // 当前主机数
    "remote_total": 10
}

升级-服务

基本信息

Path： /upgrade/service

Method： PUT

接口描述：

状态码：201/204 均为处理成功

错误码：400901-升级服务ID无效  400902-升级失败

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
Authorization		是	Bearer xxx

Reponse

{
    // 帐号ID
    "userid": 123456789,
    // 旧产品服务ID
    "service_id": 310007,
    // 升级产品服务ID
    "upgrade_id": 320218,
    // 红包赠送ID
    "coupon_id": 10
}

升级-行青&行业

基本信息

Path： /upgrade/industry

Method： PUT

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
Authorization		是	Bearer xxx

活动页

20221130

基本信息

Path： /activity/ac20221130

Method： POST

接口描述：

Request

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
Authorization		是	Bearer xxxx

Reponse

{
    // 帐号id
    "userid": 123456789,
    // 服务领取成功返回
    "service_success": true,
    // 红包领取成功返回
    "coupon_success": true
}

错误码列表

基本信息

Path： /

Method： GET

接口描述：

错误码	描述	备注
402000	不符合参与条件
402001	赠送服务失败	创建服务失败
402002	优惠券信息无效	优惠券查询错误
402003	赠送已领取	服务/红包等赠送

Request

Reponse

{
   "code": 402000,
   "message": "不符合活动参与条件",
   "data": null
}