向日葵
  1. yapi向日葵目录
向日葵
  • 主机管理
    • 共享主机
      • 帐号-主机列表
    • 主机列表【敏感信息获取】
      GET
    • 获取主机总数
      GET
    • 获取主机信息
      GET
    • 批量创建主机
      POST
    • 取消主机授权给子帐号
      POST
    • 授权主机给子账号
      POST
    • 删除主机
      DELETE
    • 主机功能模块
      GET
    • 获取主机KVM键鼠信息
      GET
    • 保存主机KVM键鼠信息
      POST
    • 代理kvm_misc接口(主要是代理升级接口兼容kvm_misc_v2/kvm_misc)
      GET
    • 修改主机信息
      PATCH
  • 主机查询(remote-query新库接口)
    • RemoteService
      • 重新构建账号(企业)的主机查询数据
    • 获取简化版主机列表 仅包含主机有关的业务(主机信息、状态)
      GET
    • 获取主机总数
      GET
  • 插座&排插(新)
    • 错误码
    • 长链接消息
    • 向日葵智能插座接口文档
    • 获取延时开关
      GET
    • 获取基本信息
      GET
    • 增加断电自启动
      GET
    • 设置电流警告阈值
      GET
    • 设置用户配置
      POST
    • 获取开关状态
      GET
    • 开关控制
      GET
    • 获取定时开关
      GET
    • 设置定时开关
      GET
    • 删除延时开关
      GET
    • 获取设备信息
      GET
    • 设置设备升级
      GET
    • 修改定时开关
      GET
    • 获取用户配置
      GET
    • 删除断电自启动
      GET
    • 获取升级进度
      GET
    • 获取电信息
      GET
    • 添加MQTT帐号
      POST
    • 删除MQTT用户
      DELETE
    • 获取电压保护设置
      GET
    • 获取功率保护设置
      GET
    • 获取电压日志
      GET
    • 获取报警日志
      GET
    • 保存电压保护设置
      POST
    • 保存功率保护设置
      POST
    • 删除功率保护设置
      DELETE
    • 修改功率保护设置
      POST
    • 插孔全开
      POST
    • 插孔全关
      POST
    • 获取SIM卡信息
      GET
    • 获取SIM卡激活状态
      GET
    • 24小时内SIM卡激活列表
      GET
    • 激活SIM卡
      POST
    • 设置温湿度传感器数据
      POST
    • 获取温湿度传感器数据
      GET
    • 温度保护设置
      POST
    • 湿度保护设置
      POST
    • 获取湿度保护设置
      GET
    • 获取温度保护设置
      GET
    • 获取电温湿度信息
      GET
    • 获取温湿度数据
      GET
    • 插口开关操作
      POST
    • 插口列表
      GET
    • 绑定插口主机
      PUT
    • 设置插口备注
      PUT
    • 解绑插口主机
      DELETE
    • 插座信息/操作-迁移slapi
      GET
    • 插座名称/备注变更-迁移slapi
      POST
    • 设备激活
      POST
  • 分组管理
    • 获取分组列表
    • 导入分组
    • 设备绑定分组
    • 获取设备分组
    • 根据父级id加载子级分组(含授权过滤)
    • 获取指用户指定tag的子集可见tags
    • 根据分组id获取names
  • 账号管理
    • 错误码
    • 成员邀请
      • 错误码说明
      • 管理平台 - 查询已有的邀请链接
      • 管理平台 - 添加&编辑邀请链接
      • 管理平台 - 重置邀请链接
      • 管理平台 - 查询待审批的用户数量
      • 管理平台 - 查询待审批列表
      • 管理平台 - 通过/拒绝邀请链接申请
      • 邀请页面 - 获取邀请链接信息
      • 邀请页面 - 发送短信/邮件验证码
      • 邀请页面 - 填写信息加入企业
    • 个人账号登录
      • 流程说明
      • 获取绑定的企业身份列表
      • 切换指定的企业成员身份Token
      • 使用Token登录企业账号
    • 获取企业账号
    • 修改帐号信息
    • 账号列表
    • 添加账户
    • 获取账号的安全等级信息
    • 获取指定角色权限
    • 未命名接口
    • 获取角色分组列表
    • 新增角色分组
    • 更新角色分组
    • 删除角色分组
    • 获取组织部门
    • 创建组织部门
    • 修改组织部门
    • 删除组织部门
    • 获取功能模块列表
    • 删除子账号
    • 修改企业账号密码
    • 获取帐号列表统计
    • 账号发送验证码
    • 找回密码
    • 获取客户端功能显示
    • 查询企业信息
  • 客户端策略
    • 云策略V2
      • 客户端长连接通知协议
      • PolicyQueryService
        • 根据策略id查询应用的设备数
        • 根据设备id查询应用的策略
        • 查询设备信息
        • 查询策略关联的设备、分组
      • SystemPolicyService
        • 绑定设备/分组/定制包冲突预检
      • 创建策略
      • 获取单个策略
      • 更新策略
      • 获取策略列表
      • 批量删除策略
      • 客户端获取云策略
      • 绑定定制包
      • 获取绑定的定制包/安装包
      • 绑定单个策略
      • 查询策略下的设备数
      • 创建策略 已废弃
      • 查询策略下当前应用的的设备ID列表(调试用,业务没用到)
      • 单个策略绑定
      • 客户端获取旧版客户端策略
      • 绑定设备、分组
      • 获取绑定的设备、分组
      • 获取单个策略
      • 开关策略
      • 升级指定定制包的客户端策略为云策略
      • 删除策略
      • 修改策略
      • 修改策略
    • 获取策略列表
    • 创建策略
    • 获取被控client_config
    • 绑定设备、分组
    • 获取绑定的设备、分组
    • 获取单个策略
    • 开关策略
    • 删除策略
    • 修改策略
  • 客户端绑定&获取ws地址
    • 终端绑定clientid
    • 分发websocket地址接口
    • 获取终端信息
    • 申请clientid
  • 企业+服务
    • 客户端外跳登录流程
    • 企业免费-转换企业文案
    • 企业第三方-授权配置
    • 企业第三方-编辑授权配置
    • 企业第三方-取消授权
    • 企业第三方-获取第三方自建应用信息
    • 企业第三方-查询第三方通讯录同步状态
    • 企业第三方-删除同步缓存锁
    • 登录
    • 使用授权码Code换取Token
    • APP二维码登录
    • 第三方授权登录
  • 云桌面
    • 错误码
    • 清除帐号下的云桌面
    • 创建向日葵云桌面
    • 查看是否有购买资格
    • 读取单条云桌面服务
    • 计算云桌面剩余时长/流量
    • 客户端上线通知
    • 验证客户ip是否允许使用
    • 修改云桌面的向日葵访问密码
    • 向日葵云桌面开机/关机/重启
    • 查看可选的地域和可用区
    • 发送手机验证码
    • 读取云桌面服务
  • 坐席管理
    • 坐席登录
  • slapi (不可新增router, 只能挪现有的)
    • 错误码
    • 定制/批量部署
      • 判断包是否存在
      • 检测升级信息
      • 获取定制信息
      • 安装包创建设备
    • 获取开关日志
    • 获取用电量
    • 获取功能模块
    • 获取用户服务信息
    • 红包总数&红包过期提醒
    • 获取屏幕墙服务
    • 客户端获取用户服务信息
    • 绑定插座
    • 获取设备文案
    • 获取智能硬件列表logo信息
    • 绑定开机棒
    • 客户端主机登录接口
    • 同意插座/排插安全协议
    • 获取插座/排插安全协议
    • 删除开机棒
    • mac地址绑定
    • 插座固件检测升级接口
    • 删除插座
    • 远控结束后广告
    • IT资产上报
    • 绑定开机盒子
    • 获取fallback域名列表
    • 开机设备主机信息
    • 获取插座状态
    • 客户端配置上传
    • 开机插座是否绑定
  • sl-api
    • 错误码
    • 活动页
      • UUPro套装激活码兑换服务
      • 活动兑换码领取
    • 校园认证
      • 获取认证信息
      • 提交认证资料
      • 领取红包
    • 服务
      • 控制展示订阅产品
      • 新服务升级
      • 服务查询
      • 获取用户服务(可获取个人/企业类型)
    • 支付宝二维码
      • 获取支付宝周期扣款签约单(调用store-api接口)
      • 跳转阿里二维码的链接
    • 开机设备
      • 设备列表
      • 设备详情
      • 删除开机棒/开机盒子
      • Mac绑定
      • Mac绑定-修改
      • Mac解绑
      • 主机设备绑定
      • 主机设备解绑(插座)
      • 开机棒-转赠
      • IP设置查询(待废弃保留)
      • IP设置(待废弃保留)
      • 花生壳DDNS查询(待废弃保留)
      • 花生壳DDNS(待废弃保留)
      • 开机操作
    • 插座
      • 插座用电量
      • 插座耗电量
      • 插座功率
      • 删除插座/插线板
    • 定制部署
      • 获取定制限制信息
    • SDK授权登录
  • 批量部署
    • 通过主机id获取有策略的批量部署id
    • 通过主机ids获取有策略的部署列表
    • 获取批量部署统计数据
    • 获取安装包信息
    • 修改安装包定制项
    • 部署主机-推送升级
    • 获取部署主机列表
    • 部署主机-升级更新
    • 获取访问密码
    • 获取安装包列表
    • 设备对应的部署定制包信息
    • 插入用户个人授权记录
    • 查询用户个人授权
    • 重新创建部署包
    • 获取安装包的代理服务器设置
  • 转发地址分配
    • 获取主机远控&转发服务地址
    • 3分钟高速试用通道资格消费
  • 向日葵-用户相关
    • 查看用户额外信息
    • 添加用户额外信息
    • 获取父账号认证信息
  • 审计日志
    • 审计日志-操作日志
    • 操作日志-上报操作日志
    • 操作日志-获取下拉项v2
    • 审计日志-操作日志v2
    • 审计日志-远控日志
    • 审计日志-被控日志
    • 审计日志-上传文档日志
    • 登录日志-主控登录告警日志
    • 审计日志-获取文件传输日志
    • 控制端日志-最近登录日志(新)
  • 软件定制
    • 获取定制部署数据
    • 定制列表
    • 创建定制
    • 获取sos_windows定制内容
    • 获取定制限制信息
    • 修改定制包
    • 上传定制包
    • 删除定制包
    • 获取定制详情
    • 运营系统创建定制包
    • 重新创建定制包
    • 获取定制的代理服务器设置
  • RPA操作
    • 错误码
    • 单条记录
    • 列表
    • 新增
    • 更新
    • 删除
    • 日志-统计
    • 日志-列表
    • 日志-新增
    • 日志-更新
  • 安全设置
    • 保存安全设置
    • 获取安全设置
    • 安全设置:获取程序运行保护开关配置
    • 安全设置:校验程序运行保护密码
  • 私有化slapi
    • 获取定制信息
  • 定时开关机任务
    • 删除定时任务
  • 登录服务
    • 错码
    • 登录
    • 刷新Token
    • 授权登录
    • 位置查询
  • 前端mock
    • 意见反馈(目前用于RPA新功能的意见收集)
  • 快码访问服务
    • 识别码(快码)登录
    • 识别码临时远控开关
  • 通道管理
    • 获取通道列表
    • 中断通道【敏感数据】
    • 获取企业通道列表
    • 中断被控设备远控
    • 获取通道数量
  • slapi客户端头像
    • 个人版获取头像
  • 意见反馈
    • 意见反馈
  • Web网页远控
    • 错误码
    • 获取使用域名列表
    • 添加使用域名
    • 修改使用域名
    • 删除使用域名
    • 远控日志
    • 注册sdk信息
  • 公共平台接口
    • 订单接口
      • https://store-api.oray.com/orders
    • 产品接口
      • 获取产品订阅
      • 获取订单价格
    • 支付接口
      • 支付接口
  • 移动授权
    • 添加授权
    • 获取授权列表
    • 删除授权
    • 查询设备授权信息
    • 切换授权
    • 重置授权次数
  • 管控大屏
    • 近期趋势
      • 折线图数据
    • 当月远程
      • 远控时长
      • 远控次数
  • 二次身份验证
    • 发送验证码
    • 查询敏感操作允许状态
    • 验证验证码
    • 获取端设备列表触发二验阈值(不再允许再新版本调用)
    • 获取企业身份验证规则
  • 云录像
    • 上传文件流程说明
    • 云录像配置变更长连接通知
    • 桌面端:检查是否允许上传
    • 桌面端:获取上传流程的临时秘钥
    • 桌面端:云录像上传状态查询
    • 桌面端:本地录像上传(向日葵存储-私有化)
    • 桌面端:调用阿里云OSS上传文件(向日葵存储-SaaS示例)
    • 桌面端:上报上传失败状态
    • Web端:通过sid拉取视频信息(向日葵存储)
    • Web端:云录像文件下载接口(向日葵存储)
    • Web端:获取云录像存储空间占用情况(向日葵存储)
    • Web端:帐号中心获取云录像配件服务状态
    • Web端:保存-云录像上传策略&云录像备份存储配置
    • Web端:获取-云录像上传策略&云录像备份存储配置
    • Web端:校验云录像备份存储配置信息
    • 【废弃】桌面端:获取备份云录像文件上传地址
  • 产品服务
    • 配件
      • 配件试用列表
    • 产品服务
    • 账号服务
    • 企业免费版服务初始化
    • 企业免费版服务取消
    • 续费记录查询
    • 续费记录创建
    • 未命名接口
    • 获取用户服务文案
    • 取消免费升级权益
  • Oray帐号管理
    • 帐号信息/高危用户
  • 新坐席管理
    • 管理平台
      • 坐席服务首页数据
      • 新坐席列表
      • 新坐席星标客户列表
      • 删除坐席
    • 客户端接口
      • 新坐席上线接口
      • 新坐席下线接口
      • 新坐席查询状态
      • 新坐席新建星标客户
      • 新坐席删除星标客户
      • 坐席日志
      • 主控启动更新状态
      • 更新坐席日志
      • 新坐席日志列表接口
    • 坐席迁移
      • 坐席迁移
    • 新建星标客户
    • 批量导入星标客户
    • 星标客户-获取分组列表
    • 星标客户-获取分组下星标用户
    • 星标客户-创建星标分组
    • 星标客户-指定分组
    • 星标客户-删除分组
    • 星标客户-更新分组(重命名)
    • 星标客户-移动排序
  • 向日葵公众号
    • 导出接口文档
      • 导出接口文档
    • 用户微信绑定关系
      • 查询当前用户和微信的绑定关系
      • 解绑,删除当前用户和微信的绑定关系
    • 微信公众号相关接口
      • 指定用户ID通过公众号发送模板消息
      • 提供给微信公众平台调用的回调地址
      • 创建带用户信息的公众号二维码
  • 开机设备
    • 开机设备列表
    • 开机棒开机
    • Q0.5数据上报
  • client-api
    • 软件升级接口
    • 留资
  • 系统安全 - 登录限制
    • 批量导入限制列表 全局
    • 获取多因子配置
    • 保存多因子配置
    • 获取Ip限制列表 全局
    • 批量保存限制列表 全局
    • 获取Mac限制列表 全局
    • 批量保存Mac限制列表 全局
    • 获取IP限制列表 - 角色
    • 批量保存IP限制列表 - 角色
    • 获取Mac限制列表 - 角色
    • 批量保存Mac限制列表 - 角色
    • 获取Schedule限制列表 - 角色
    • 保存Schedule限制列表 - 角色
    • 获取Schedule限制列表 全局
    • 保存Schedule限制列表 全局
    • 获取IP限制列表 - 帐号
    • 批量保存IP限制列表 - 帐号
    • 获取Mac限制列表 - 帐号
    • 批量保存Mac限制列表 - 帐号
    • 获取Schedule限制列表 - 帐号
    • 保存Schedule限制列表 - 帐号
    • 获取因子用户
    • 保存因子用户
  • client-api Copy
    • 软件升级接口
  • 远控账号/设备黑名单
    • 获取全部账号/设备黑名单
    • 保存设备黑名单记录
    • 获取指定设备黑名单记录
    • 删除设备黑名单记录
    • 获取设备黑名单列表
    • 保存账号黑名单记录
    • 保存账号/设备黑名单记录
    • 获取指定账号黑名单记录
    • 删除账号黑名单记录
    • 获取账号黑名单列表
  • 远控安全检测
    • 敏感进程信息上报
    • 中断远程操作
    • 中断结果通知
  • 文件分发 - New
    • [对端]文件分发获取主机分发任务
    • [对端]文件分发上报主机分发任务状态
    • [对端]获取指定分发任务指定文件已完成的主机Peers
    • 删除分发主机
    • 获取文件分发列表
    • 创建文件分发任务
    • 获取调度文件列表
    • 创建调度文件
    • 获取调度主机列表
    • 删除分发文件
    • 获取文件分发详情
    • 删除文件分发
    • 重新推送整个任务到端
    • 重新推送指定任务到指定主机
  • 可疑/敏感应用
    • 获取可疑/敏感应用列表
    • 创建敏感应用
    • 更新敏感应用
    • 远控触发应用黑名单日志
    • 删除敏感应用
  • 设备列表开启
    • 主机列表开关
    • 主机列表已开启列表
    • 主机列表开关开启
    • 主机列表开关-授权明细
    • 主机列表开关-授权更新
  • 资源上传
    • 上传
    • 获取资源
  • 易维融合 & 中国通用一期
    • 附:桌面端接口签名算法
    • 附:其他关联的业务接口
    • 附:错误码
    • 工单消息通知长链接协议 & 消息文案说明
    • 桌面端:获取易维提交工单地址
    • 桌面端:获取易维查询工单地址
    • 桌面端/Web端:获取易维控制台地址
    • Web端:获取易维可用的网页组件渠道
    • Web端:查询或绑定的易维服务商信息(主帐号首次调用初始化)
    • Web端:查询是否有易维服务
  • slsvr
    • express_login
  • 微信公众号通知
    • exkey换取token
    • 获取微信用户绑定关系
  • Q5线缆状态接口
    • 获取Q5线缆状态
    • 更新Q5线缆状态
  • 广告管理
    • 查询账号用户分群限制
    • 查询广告限制频率/信息
    • 查询账号观看广告送阳光明细
    • 账号观看广告送阳光通知
    • 获取下发的广告sdk (待废弃)
  • 远控数据报表(control-report)
    • 查询企业每日远控请求数-小时粒度
    • 查询企业每日远控请求数-分钟级粒度
    • 查询企业每日远控成功次数-小时粒度
    • 查询企业每日成功远控次数-分钟粒度
    • 查询远控时长排行
    • 查询企业当天每小时远控次数
    • 查询企业每日远控次数
    • 查询设备被控次数排行
  • 年度报告
    • intel
    • 意见反馈
      • 获取提交报告
      • 上传用户报告截图&别名
      • 提交意见接口
    • 2023年度报告
  • yapi向日葵目录
    • 主机服务(PHP)
    • 被控核心API服务
    • 向日葵网站
    • 向日葵客户端rpc
    • 向日葵坐席
    • slrc
    • asapi
    • slapi-v2
    • 向日葵管理(sl-api)
    • api.sunlogin.oray.com
  • 分组规则
    • 返回设备匹配的分组
    • 添加分组规则
    • 获取分组规则列表
    • 查询分组规则详情
    • 删除分组规则
    • 更新分组规则
  • 客户端日志
    • 提交客户端重启日志
  • 增值服务授权
    • 增值服务-添加成员授权
    • 增值授权-开启/关闭成员授权
    • 增值服务-移除成员授权
    • 增值服务-授权成员列表
    • 增值服务-部门授权
    • 增值服务-数据统计
    • 增值服务-查询授权状态
    • 增值服务-批量成员授权
    • 增值服务-获取授权部门列表
    • 增值服务-获取部门授权成员列表
    • 增值服务-更新部门成员状态
    • 增值服务-移除部门授权
    • 增值服务-更新部门授权
    • 增值服务-获取成员授权列表
    • 增值服务-提交授权申请
    • 增值服务-获取申请人数
    • 增值服务-获取申请授权列表
    • 增值服务-受限上报
    • 设备授权 - 添加授权
    • 设备授权 - 更新授权
    • 设备授权 - 移除授权
    • 设备授权 - 授权列表
    • 设备授权 - 单设备授权信息
    • 设备授权 - 批量添加授权
    • 设备授权 - 多设备授权信息
    • 设备授权 - 授权数据统计
  • Sentry配置
    • 获取sentry配置
  • 用户分群
    • 获取用户挽留分群产品ID
    • 获取购买弹窗尺寸
    • 检测是否存在企业免费分群
    • 通知已显示挽留
    • iOS端购买是否支持其他支持方式
  • API集成
    • 附:错误码
    • 附:第三方调用接口/桌面端验证流程
    • API配置相关
      • 长链接通知
      • 桌面端API应用配置流程
      • Web端:编辑API配置信息
      • Web端&桌面端:获取API配置信息
      • Web端:校验域名DNS状态
      • Web端:校验SSL证书
    • Web端:创建APIKEY
    • Web端:删除APIKEY
    • Web端:获取APIKEY列表
    • 第三方:获取接口调用凭证(对外)
    • 桌面端:验证接口调用凭证
  • 识别码列表
    • 查询-识别码记录-列表
    • 新增-识别码记录
    • 删除-识别码记录
    • 编辑-识别码记录
  • 远控数据报表(control-report) Copy
    • 查询远控时长排行
    • 查询企业当天每小时远控次数
    • 查询企业每日远控次数
    • 查询设备被控次数排行
  • 销售促销
    • 大促动态图标
  • 管控大屏2.0
    • 管控大屏接口说明
    • 获取区域主机总数
  • IT精英-多协议远控
    • 错误码
    • 多协议设备列表
      • 新增多协议设备
      • 批量新增多协议设备(用于导入)
      • 查询多协议设备列表
      • 查询多协议设备详情
      • 更新多协议设备信息
      • 删除多协议设备
      • 保存快速连接记录
      • 查询最近的快速连接设备列表
    • 多协议设备分组
      • 新增多协议设备分组
      • 编辑多协议设备分组
      • 删除多协议设备分组
      • 查询所有多协议分组
  • 智能工作报告
    • 关闭领取体验智能报告
    • 开启/结束智能报告
    • 获取智能报告设置
    • 保存智能报告设置
  • 云存储
    • 创建临时token
    • 创建临时token 续期
    • 删除临时token
    • 获取云存储服务
    • remote绑定状态查询
    • 查询已开启的remote绑定设备
    • remote绑定设备 开启 和 关闭
    • 删除remote绑定
    • remote绑定列表
    • webdav接口
    • webdav接口
    • webdav接口
    • webdav接口
    • webdav接口
    • webdav接口
    • webdav接口
    • webdav接口
  • 设备授权(entremote-relation-query)
    • rebuild
      • 初始化授权关系
      • 重建设备授权关系
      • 重建云策略关系
    • remotes
      • 获取授权关系
      • 获取设备ID列表
    • tag
      • 查询分组
    • dept
      • 查询部门
    • entusers
      • 查询账号
  • Vpro
    • Vpro-获取vpro状态信息
  • 硬件告警策略
    • 创建硬件告警策略
    • 获取硬件告警策略ByID
    • 删除硬件告警策略
    • 修改硬件告警策略
    • 获取告硬件告警策略列表
    • 修改告警策略状态
    • 获取硬件告警策略统计主机数
    • 硬件告警日志列表
    • 硬件告警日志保存
    • 获取硬件策略通过部署包key或者主机ID
  • IT资产
    • 新增/变更硬件信息
  • console(向日葵控制台中转层)
    • 获取客户端相关特性
    • 客户端根据账号(或服务级别)获取相关的文案、图片等信息
    • 客户端获取账号服务扩展
    • 入口域名
  • ovm
    • 磁盘管理
      • 获取磁盘列表
      • 添加磁盘
      • 删除磁盘
      • 编辑磁盘
      • 复制磁盘
      • 移动磁盘
      • 获取磁盘详情
    • 镜像管理
      • 复制镜像-虚拟机附加使用
      • 获取镜像列表
      • 添加镜像
      • 删除镜像
      • 编辑镜像
      • 复制镜像
      • 移动磁盘(镜像)
      • 磁盘(镜像) 传输
      • 磁盘(镜像)传输详情
      • 获取磁盘(镜像)详情
    • 网络过滤器
      • 获取网络过滤器列表
      • 获取网络过滤器详情
    • VNIC 配置集
      • vnicprofiles列表
      • vnicprofile详情
      • 删除vnicprofiles
      • 修改vnicprofile
      • 添加vnicprofile
    • 数据中心
      • 获取数据中心下网络
      • 数据中心列表
    • 网络
      • 网络列表
      • 网络详情
      • 添加网络
    • 主机
      • 获取主机列表
      • 主机指标
    • 云电脑
      • 获取云电脑列表
      • 新增云电脑
      • 获取云电脑详情
      • 删除云电脑
      • 修改云电脑名称备注
      • 操作云电脑
    • 镜像(模板)
      • 获取镜像列表
      • 新增镜像
    • 概览统计
      • 瞬时值统计
      • CPU 统计数据
      • 内存统计数据
      • 存储统计数据
      • 云电脑统计数据
    • 获取域列表
    • 外部供应商列表
  • 设备通知开关
    • 账号设备通知开关配置明细
    • 账号设备通知开关配置
  • 应用中心
    • 查看是否具备对应配件
  • 敏感进程告警策略
    • 获取敏感进程策略通过部署包key或者主机ID
    • 进程告警日志保存
    • 创建敏感进程策略
    • 敏感进程策略列表
    • 获取敏感进程告警策略
    • 更新敏感进程告警策略
    • 更新敏感告警策略状态
    • 删除敏感进程告警策略
    • 获取敏感进程告警日志列表
  • 最近列表
    • 最近列表
    • 最近列表-变更
  • ad域相关
    • 查看ad开关
    • 修改ad开关状态
    • 查看完整的配置
    • 设置完成的配置
    • 查看ldap的同步状态
    • 手动触发同步状态
    • ldap 连接测试
  • 消息中心
    • 消息订阅
      • 获取消息订阅配置列表
      • 修改指定消息订阅配置
    • 消息列表(站内信)
      • 消息列表
      • 风险上报
      • 消息全部已读
      • 删除指定的消息记录
      • 指定消息已读
      • 统计消息数量
      • 按类型分组统计未读数量
      • 清空消息列表
    • 消息通知
      • 客户端弹窗通知长连接协议
  • 异步日志导出
    • 导出列表查询
    • 创建导出任务
    • 删除导出任务
  • StarNet
    • 开关变更长链接说明 -- 废弃
    • 更新说明
    • 获取StarNet服务端登录凭证
    • StarNet近期阳光收集&统计剩余时长
    • 变更用户StarNet开关状态
  • 新屏幕墙
    • websocket
    • 获取屏幕墙列表
    • 获取屏幕墙详情
    • 创建屏幕墙
    • 修改屏幕墙
    • 删除屏幕墙
    • 修改屏幕墙配置
    • 获取屏幕墙设备列表
    • 变更屏幕墙主机排序
    • 通过slsvr获取屏幕图地址
    • 删除屏幕墙主机
    • 获取屏幕墙全局设置
    • 保存屏幕墙全局设置
    • 保存某个屏幕墙设置
  • 客户端模块更新
    • 保存客户端模块信息
    • 获取客户端模块列表
  • 登录设备
    • 获取登录设备
    • 位置查询
  • 虚拟屏幕
    • 扩展屏发送请求
  • 配件服务
    • 查询配件服务
    • 查询有效配件服务列表
    • 消耗配件服务次数
    • 查询是否存在配件记录
  • 云监控
    • 查询策略
    • 创建策略
    • 删除策略
    • 更新策略
    • 查询主机监控授权
    • 上传云监控视频信息
  • 账号登录安全
    • 开启新设备登录
  • 单点登录配置相关
    • 设置单点登录配置
    • 获取单点登录配置
  • SDK授权
    • 公有云认证
    • 私有云认证
  • 产品经理接单(意见反馈)
    • 接入指南
    • 获取易维网页WebSDK的授权认证(产品经理接单)
  • 企业授信
    • 获取授信账号列表
    • 新增授信记录
    • 更新授权信息
    • 批量新增授信记录
    • 下载授信文件
    • 提交授信申请
    • 保存授权码
    • 获取主控授信记录
    • 查询指定设备授信码
    • 获取授信申请列表
  • AI助手
    • 服务配额查询
    • 脚本生成器
    • 通用聊天助手(支持多轮会话)- 暂不开放
  • 企业脚本管理
    • 客户端:通知执行脚本长连接通知
    • Web端:获取企业脚本列表
    • Web端:添加企业脚本
    • Web端:编辑企业脚本
    • Web端:获取企业脚本详情
    • Web端:删除企业脚本
    • Web端:创建脚本执行任务
    • Web端:获取脚本执行任务列表(执行记录)
    • Web端:获取脚本执行任务详情
    • Web端:获取脚本执行任务的接收者列表(主机执行列表)
    • Web端:重新执行指定的脚本执行任务
    • 客户端:上报脚本任务执行结果
  • 向日葵团队版
    • 错误码大全
    • 【管理平台webapi】获取用户服务信息
    • 【客户端slapi】获取用户服务信息
    • 【客户端clientapi】获取个人服务信息卡片
    • 【端内网页sl-api】获取用户服务信息
    • 【官网价格页sl-api】获取用户服务信息
    • 【客户端slapi】获取用户信息
    • 【管理平台】离开所在团队
    • 【管理平台】获取我的团队成员列表
    • 【管理平台】加入新的团队成员
    • 【管理平台】删除已有的团队成员
    • 【管理平台】批量修改团队成员配额
    • 【管理平台】修改团队成员备注
    • 【管理平台】查询可用配额信息
  • 创建主机
    POST
  • prohibition
    GET
  • 未命名接口
    GET
  1. yapi向日葵目录

向日葵管理(sl-api)

向日葵管理(sl-api)

公共分类

广告

获取广告图

基本信息

Path: /advertisement

Method: GET

接口描述:


Request

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/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-Typeapplication/x-www-form-urlencoded是

Body

参数名称参数类型是否必须示例备注
remoteidtext是1665808
domaintext是xxx.yyy.com

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

基本信息

Path: /share/:remoteid/:status

Method: PUT

接口描述:

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

Request

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/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

路径参数

参数名称示例备注
remoteid213234主机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-Typeapplication/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

参数名称参数值是否必须示例备注
AuthorizationBearer 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-Typeapplication/x-www-form-urlencoded是

Body

参数名称参数类型是否必须示例备注
contenttext是content
downloadTimetext否00:00有则用,无则设置默认
remotestext是
linktext否

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是mouthmouth/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-Typeapplication/x-www-form-urlencoded是

Body

参数名称参数类型是否必须示例备注
remoteidtext是3124345主机ID
accounttext否orayPC用户名,选择windows用户验证方式时才传
passwordtext是oray.com1、windows验证方式时传windows密码,2、客户端访问密码
typetext是1windows用户验证方式:1;访问密码验证:0

Reponse

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

更新云监控配置

基本信息

Path: /monitor

Method: PUT

接口描述:


Request

Headers

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

Body

参数名称参数类型是否必须示例备注
remoteidtext是4234323主机ID
statustext是1云监控状态,1开启,0关闭
desktoptext否1监控桌面
frameratetext否1帧速率,0:1帧/秒;1:2帧/秒
timetypetext否0监控时间:1自定义时间,0主机在线时
timestext否15728655,16777215,16777215,15728643,16769023,16740367,16777215自定义时间段,7个时间段,用“,”隔开

获取主机云监控信息

基本信息

Path: /monitors/:remoteid

Method: GET

接口描述:


Request

路径参数

参数名称示例备注
remoteid22547817主机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-Typeapplication/x-www-form-urlencoded是

Body

参数名称参数类型是否必须示例备注
shareuseridtext是54035
remoteidtext是22104678

开启主机共享

基本信息

Path: /shareremote

Method: POST

接口描述:


Request

Headers

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

Body

参数名称参数类型是否必须示例备注
accountstext是123123123用回车隔开
remoteidtext是22104678
modeltext是all
istagtext否选中为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

路径参数

参数名称示例备注
typepayedpayed:付费服务;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-Typeapplication/x-www-form-urlencoded是
X-AppIDasdfkljasdflkjwer是应用ID
X-Noncewasdf123asdf1234是随机串
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

参数名称参数值是否必须示例备注
AuthorizationBearer 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-Typeapplication/json是
AuthorizationBearer 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-Typeapplication/x-www-form-urlencoded是

路径参数

参数名称示例备注
seatid

坐席密码-重置

基本信息

Path: /seats/password/:seatid

Method: PUT

接口描述:


Request

Headers

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

路径参数

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

Query

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

坐席强制下线

基本信息

Path: /seats/:clientid/authorization

Method: DELETE

接口描述:


Request

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/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-Typeapplication/x-www-form-urlencoded是

路径参数

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

坐席更新

基本信息

Path: /seats/:seatid

Method: PUT

接口描述:


Request

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/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-Typeapplication/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-Typeapplication/x-www-form-urlencoded是

路径参数

参数名称示例备注
securityid1安全保护配置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-Typeapplication/x-www-form-urlencoded是

路径参数

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

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

基本信息

Path: /seats/mac

Method: POST

接口描述:


Request

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/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-Typeapplication/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-Typeapplication/x-www-form-urlencoded是

Query

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

Reponse

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

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

点赞

基本信息

Path: /keyboard/like

Method: POST

接口描述:


Request

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/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-Typeapplication/x-www-form-urlencoded是
cookie是必须,接口里调用客户端rpc要用到,取oray.com的即可

路径参数

参数名称示例备注
actionentry进入 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-Typeapplication/x-www-form-urlencoded是

Body

参数名称参数类型是否必须示例备注
company_nametext是上海贝锐信息科技股份有限公司公司名称
industrytext是软件服务行业
mobiletext是159xxxxxxxx联系手机号
contacttext是老冯联系人名称
descriptiontext是1234备注
referral_idtext是推广ID
scaletext是50人公司规模
popularize_urltext是https://www.baidu.com来源推广链接
brandtext否默认 3 向日葵
emailtext否默认 -
titletext否默认 -
e_typetext否默认 预约演示
codetext是手机验证码
activitytext是activity由前端控制 看需求 a页面进来时 SL_LEAD b进来是 SL_ENT 后面可能还有c进来 SL_XXX

Reponse

ok

更新留资页信息接口

基本信息

Path: /service/experience

Method: PUT

接口描述:


Request

Headers

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

Body

参数名称参数类型是否必须示例备注
mobiletext是159xxxxxxxx联系手机号
contacttext是老冯联系人名称
codetext是手机验证码
activitytext是activity由前端控制 看需求 a页面进来时 SL_LEAD b进来是 SL_ENT 后面可能还有c进来 SL_XXX
idtext是
sourcetext是
descriptiontext是

Reponse

ok

获取留资页信息接口

基本信息

Path: /service/experience

Method: GET

接口描述:


Request

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/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-Typeapplication/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-Typeapplication/x-www-form-urlencoded是
Authorization是Bearer xxx

活动页

20221130

基本信息

Path: /activity/ac20221130

Method: POST

接口描述:


Request

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/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
}
上一页
slapi-v2
下一页
api.sunlogin.oray.com
Built with