向日葵
  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向日葵目录

slapi-v2

slapi-v2

公共分类

免费限速提示

基本信息

Path: /client/free-tips

Method: GET

接口描述:


Request

Query

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

Reponse

{
    "code": 0,
    "message": "SUCCESS",
    "data": {
        "paidinfo": "亲爱的用户,已为您智能选择最优网络路线",       // 付费提示
        "info": "欢迎免费使用向日葵,当前免费版带宽最高可享3Mbps",  // 免费提示
        "interval": 36000,                                          // 秒,再次显示时间
        "upgradeinfo": "升级不限速",                                // 升级提示信息(接在免费提示后面的文字)
        "upgradeurl": "https://sunlogin.oray.com/personal/price",   // 升级链接
        "upfrequence": 3,                                           // 升级提示显示频率,显示 n 次限速提示,才提示一次升级信息
        "isshow": true,                                             // 是否显示,false时全部提示不显示
        "delay": 5,                                                 // 延时 n 秒显示
        "tipstype": 0,                                               // 0显示免费提示,1显示付费提示
        "security_tips": "{'zh_CN':'重要提醒:远程过程中,你的屏幕所有内容将被对方全程观看/操作。提供本机识别码前,请确认信任对方。若你提供本机识别码和验证码,则对方无需本机确认即可远程控制,请谨慎提供验证码!','en':'Your screen contents will be fully observed during the session. With your passcode, the\\nremote peer could operate your device without authorization. PROVIDE WITH CAUTION!','zh_TW':'重要提醒:被控過程中,你的荧幕所有內容將被對方全程觀看/操作。提供本機識別碼前,請確認信任對方。若你提供本機識別碼和驗證碼,則對方無需本機確認即可遠程控制,請謹慎提供驗證碼!'}"                                         // 
    },
    "category": "client",
    "action": "freetips"
}

同意公测

基本信息

Path: /passport/agree-beta

Method: POST

接口描述:


Request

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/x-www-form-urlencoded是
AuthorizationBearer eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MDAxNDI0MDAsImp0aSI6IjE2MzRkNWMyY2E2NzJiOTgxMWVmNjQ3Yjc2NWI0Yjk2IiwiaXNzIjoieW9vbnR5YXciLCJyb2xlIjo0LCJzZXIiOiJhdXRoLm9yYXkuY29tIiwidWlkIjoxMjUwMDUxMiwiYXBwIjoia3dxbGVpN2U5bzVTdkhHTE5vQ1cifQ.Iy63zzTdi2QqRlkt3EcJNzD-lIfLv4fmMgIKrG2q_rTIqlO4nPixCEni8hek-SJCS1khVDHEpyoL8PfcjeYKjJsdiaS_XLsoBw99eHROPKt_mu54xz-jg0hwYMc46CraZT63uQQoTI98GjIePfQyczlrY0XzhcCNLzz2lHPvntE是

Reponse

{
   "code": 0,
   "message": "SUCCESS",
   "data": [],
   "category": "passport",
   "action": "agreebeta"
}

向日葵硬件禁用

基本信息

Path: /sunlogin/device-disable

Method: POST

接口描述:

1、加密规则:

对 sn、_t为键值的数组进行ksort排序后 implode以英文逗号 , 将数组变成字符串,加上密钥后md5

如:

const SECRET_KEY = '+=huashengkui=+'; // 密钥

$sign = md5(implode(',', ksort($param)) . self::SECRET_KEY) 


2、错误码

2 => '验证无效'

5 =>'参数有误'

1209 => '设备不存在'

Request

Headers

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

Body

参数名称参数类型是否必须示例备注
sntext是03677568852开机棒\开机盒等序列号
_ttext是1619069826时间
signtext是a49e1fd411628117c2710b1581e184a4加密后的密钥(MD5)
_formattext否json支持两种返回格式 默认xml

Reponse

{
  "code": 0,
  "message": "SUCCESS",
  "data": {},
  "category": "sunlogin",
  "action": "deviceaddlog"
}

广告屏蔽设置

基本信息

Path: /adver/ad-setting

Method: POST

接口描述:


Request

Headers

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

Body

参数名称参数类型是否必须示例备注
tagtext是x_remoteend广告位标识。x_remoteend:X远控结束
typetext是1广告展示类型:1、14天后展示 2、不再显示
_formattext否json返回类型参数
recovertext否1恢复默认广告规则。1:恢复。(定义备用,目前api暂未实现对应逻辑)

Reponse

{
   "code": 0,
   "message": "SUCCESS",
   "oray_code": "",
   "data": [],
   "oraycode": "",
   "category": "adver",
   "action": "adsetting"
}

意见反馈

基本信息

Path: /feedback/create

Method: POST

接口描述:


Request

Headers

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

Body

参数名称参数类型是否必须示例备注
accounttext是帐号名
contacttext是联系人名称
contenttext是反馈内容
mobiletext否手机号
osversiontext是操作系统版本
osnametext是操作系统名称
labeltext否在线教育内容标签(目前只有直播的意见反馈有)
emailtext否邮箱
fieldtext否桌面直播业务名称(目前只有直播的意见反馈有)

Reponse

{
   "code": 0,
   "message": "SUCCESS",
   "data": [],
   "category": "feedback",
   "action": "create"
}

检查ios公测资格

基本信息

Path: /passport/check-beta

Method: GET

接口描述:


Request

Headers

参数名称参数值是否必须示例备注
AuthorizationBearer eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MDAxNDI0MDAsImp0aSI6IjE2MzRkNWMyY2E2NzJiOTgxMWVmNjQ3Yjc2NWI0Yjk2IiwiaXNzIjoieW9vbnR5YXciLCJyb2xlIjo0LCJzZXIiOiJhdXRoLm9yYXkuY29tIiwidWlkIjoxMjUwMDUxMiwiYXBwIjoia3dxbGVpN2U5bzVTdkhHTE5vQ1cifQ.Iy63zzTdi2QqRlkt3EcJNzD-lIfLv4fmMgIKrG2q_rTIqlO4nPixCEni8hek-SJCS1khVDHEpyoL8PfcjeYKjJsdiaS_XLsoBw99eHROPKt_mu54xz-jg0hwYMc46CraZT63uQQoTI98GjIePfQyczlrY0XzhcCNLzz2lHPvntE是

Reponse

{
   "code": 0,
   "message": "SUCCESS",
   "data": {
      "enable": 0,
      "url": "https://sunlogin.oray.com",
      "description": "内测描述内测描述内测描述内测描述内测描述内测描述内测描述内测描述"
   },
   "category": "passport",
   "action": "checkbeta"
}

用户进程数据保存

基本信息

Path: /remote/save-process

Method: POST

接口描述:


Request

Headers

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

Body

{
   "process": [
      {
         "role": 1,
         "userid": 1231,
         "fastcode": 895859625,
         "osversion": "3.0.12",
         "process": "test",
         "appname": "测试",
         "cpu": "1.7",
         "memory": "1.2",
         "gpu": "1.3",
         "sid": 135828258445
      },
      {
         "role": 2,
         "userid": 33333,
         "fastcode": 895859625,
         "osversion": "3.0.12",
         "process": "test",
         "appname": "测试",
         "cpu": "1.7",
         "memory": "1.2",
         "gpu": "1.3",
         "sid": 135828258445
      }
   ]
}

Reponse

<?xml version="1.0" encoding="utf-8"?>
<response>
    <category>remote</category>
    <action>saveprocess</action>
    <code>0</code>
    <message>SUCCESS</message>
    <datas>

</datas>
</response>

获取主机扩展的信息(拆分get-remoteaddr)

基本信息

Path: /remote/expand

Method: GET

接口描述:


Request

Query

参数名称是否必须示例备注
remoteid否907932306主机id
authcode是1ae15088a20f9d67da550f904a5cfae3md5(t + remoteid + 'sunlogin.com')
t是1654764114时间戳
_format否json返回的格式,不传默认是xml

Reponse

{
	"code": 0,
	"message": "SUCCESS",
	"stdcode": 0,
	"data": {
		"hw_model": "",    // 控控型号
		"remote_err": null // 远控方舟/控控错误提示
	},
	"category": "remote",
	"action": "expand"
}

获取客户端ID

基本信息

Path: /api/clientids

Method: GET

接口描述:

客户端新装时打开请即刻调用此接口,获取clientid.保存在配置文件上。下次登录时再判断是否有这个clientid. 有了不需要再调用

Request

Query

参数名称是否必须示例备注
authkey是f5e0742d479cd98a1291dec061f6ea9c
_format是json返回格式。默认XML

Reponse

<?xml version="1.0" encoding="utf-8" ?>
<response>
<category>api</category>
<action>clientids</action>
<code>0</code>
<message>SUCCESS</message>
<datas>
<datatype="field"name="clientid">52795c2d-7995-496c-aa1f-cf40af2a6c1c</data>
</datas>
</response>

获取所有向日葵硬件logo

基本信息

Path: /sunlogin/get-logo

Method: GET

接口描述:


Request

Reponse

{
   "code": 0,
   "message": "SUCCESS",
   "stdcode": 0,
   "data": {
      "ark": {
         "name": "控控/方舟",
         "model": {
            "A1": {
               "url": "https://cdn.orayimg.com/sunlogin/slapi/img/hardware/C1@100.png",
               "name": "控控A1"
            },
            "A2": {
               "url": "https://cdn.orayimg.com/sunlogin/slapi/img/hardware/C1@100.png",
               "name": "控控A2"
            },
            "A2PRO": {
               "url": "https://cdn.orayimg.com/sunlogin/slapi/img/hardware/C1@100.png",
               "name": "控控A2Pro"
            },
            "Q2PRO": {
               "url": "https://cdn.orayimg.com/sunlogin/slapi/img/hardware/C1@100.png",
               "name": "方舟Q2Pro"
            }
         }
      },
      "wakeup": {
         "name": "开机棒",
         "model": {
            "K1": {
               "url": "https://cdn.orayimg.com/sunlogin/slapi/img/hardware/C1@100.png",
               "name": "开机棒(独享版)"
            },
            "k2": {
               "url": "https://cdn.orayimg.com/sunlogin/slapi/img/hardware/C1@100.png",
               "name": "开机棒(局域网版)"
            }
         }
      },
      "smartplug": {
         "name": "插座/插线板",
         "model": {
            "C1": {
               "url": "https://cdn.orayimg.com/sunlogin/slapi/img/hardware/C1@100.png",
               "name": "开机插座C1"
            },
            "C1-2": {
               "url": "https://cdn.orayimg.com/sunlogin/slapi/img/hardware/C1@100.png",
               "name": "开机插座C1-2"
            },
            "C1PRO": {
               "url": "https://cdn.orayimg.com/sunlogin/slapi/img/hardware/C1@100.png",
               "name": "开机插座C1Pro"
            },
            "C2": {
               "url": "https://cdn.orayimg.com/sunlogin/slapi/img/hardware/C1@100.png",
               "name": "开机插座C2"
            },
            "P1": {
               "url": "https://cdn.orayimg.com/sunlogin/slapi/img/hardware/C1@100.png",
               "name": "开机插线板P1"
            },
            "P1PRO": {
               "url": "https://cdn.orayimg.com/sunlogin/slapi/img/hardware/C1@100.png",
               "name": "开机插座P1Pro(蓝牙)"
            },
            "P2": {
               "url": "https://cdn.orayimg.com/sunlogin/slapi/img/hardware/C1@100.png",
               "name": "开机插线板P2"
            },
            "P4": {
               "url": "https://cdn.orayimg.com/sunlogin/slapi/img/hardware/C1@100.png",
               "name": "开机插线板4G"
            }
         }
      }
   },
   "category": "sunlogin",
   "action": "getlogo"
}

获取运营商、p2p服务器地区

基本信息

Path: /remote/get-network

Method: GET

接口描述:


Request

Query

参数名称是否必须示例备注
remoteid否主机id,fastcode和remoteid传其中一个即可
fastcode否快码,fastcode和remoteid传其中一个即可
remoteip是被控ip

Reponse

{
	"code": 0,
	"message": "SUCCESS",
	"data": {
		"p2pserver": "华南",        // p2p 服务器地区
		"controlisp": "中国电信",   // 主控运营商
		"remoteisp": "中国移动",    // 被控运营商
		"service": "入门版",        // 通道级别
		"servicelink": "https://service.oray.com/question/10281.html?utm_campaign=sl", // 卡顿的问号跳转的链接
		"upgradelink": "https://sunlogin.oray.com/price", // 升级链接
		"isupgrade": 1 // 是否提示升级服务,目前精英版以下(含)会返回1
	},
	"category": "remote",
	"action": "getnetwork"
}

记录开机棒、开机盒子激活时间

基本信息

Path: /sunlogin/record-wakeup-time

Method: PUT

接口描述:

这边把接口转移到  http://yapi.orayer.com:3000/project/187/interface/api/10967

1、加密规则:

对 sn、uptime、description、_t为键值的数组进行ksort(对关联数组按照键名进行升序排序)后 ,以英文逗号 , 将数组变成字符串,加上密钥后md5

php如:

const SECRET_KEY = '+=huashengkui=+'; // 密钥

ksort($param);

$sign = md5(implode(',',$param ) . self::SECRET_KEY)


2、错误码

1 => '失败'

2 => '验证无效'

5 =>'参数有误'

1209 => '设备不存在'

Request

Headers

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

Body

参数名称参数类型是否必须示例备注
sntext是03677568852开机棒\开机盒等序列号
uptimetext是2021-04-22 13:45:17激活时间
_ttext是1619069826time()时间 (防超时)
signtext是a49e1fd411628117c2710b1581e184a4加密后的密钥(MD5)
_formattext否json支持两种返回格式 默认xml

Reponse

{
   "code": 0,
   "message": "SUCCESS",
   "data": {},
   "category": "sunlogin",
   "action": "deviceaddlog"
}

坐席管理

websoctet业务消息结构

基本信息

Path: /xxx

Method: GET

接口描述:

服务器给客户端发送业务消息(重连、下线),业务消息的基础为标准的Websocket二进制数据桢RFC6455。二进制数据帧的Payload即为业务消息的结构,数据为protobuf格式的二进制数据,定义如下:

enum MessageType {
        SYS = 0x00;
        GROUPSTATE = 0x01;
        STATE = 0x03;
        DATA = 0x02;
        RECONN = 0x04;
        CLOSE = 0x05;
}


enum CloseReason {
    UNKNOWN = 0; // 未知,视为意外断开,“未知”包含了有可能不会收到Close消息的断开,如:服务器维护,网络异常,服务进程异常等等
    FORCE = 1; // 表示断开为业务端发起的强制下线,客户端后续行为按业务要求处理
    USER = 2; // 用户行为断开,主动下线,关闭/重启客户端等等
    RECONNECT = 3; // 重连,客户端收到重连消息后,断开原连接时发送,收到Reconnect会在一个心跳周期内保持当前客户端的会话状态数据(业务上不下线,连接数为当前clientid保留),重连后可继续业务
    ILLEGAL = 5; // 客户端被判断为非法行为,系统断开。如:发送不合法的消息内容,发送超长的消息,发送频率过快
}

message Message {
    MessageType Type = 1; // 消息类型,见 MessageType 枚举
    int64 SerialNumber = 2; // 消息的序号,可选(空为0值),如果客户端发送的信息希望得到保序的响应,在发送消息时应该生成并带上值,服务端针对该消息的回复将带上对应的序号
    bytes Payload = 3; // 数据载荷
}

message ReconnectPayload {
    int64 Deadline = 1;
}

// 关闭原因
message ClosePayload {
    CloseReason Reason = 1;
}

// 分组状态通知
message GroupState {
    int64 Limit = 1;
    int64 Online = 2;
}

ClOSE  连接关闭消息
由业务发起的强行下线,紧接着服务器会按正常的协议流程发送Close控制消息并断开连接。请按业务要求规范进行后续操作(一般就是不要重连了)。


RECONNECT
由服务端发起的预定重连,会指定一个UTC时间戳的deadline(deadline很有可能是运维人员的工作时间,若超过时限连接有可能会因维护工作进行而无故断开),指定客户端必须在此时间前重连服务,如果可以应在收到消息后立即断开发起重连业务。本业务主要为服务端维护预备,服务扩(缩)容进行动态均衡调配,具体的重连时间(如果可以应立即)客户端可以自行决定,即如果当前用户进行的业务必须保持连接,可以在完成后再进行。

Request

修改坐席名称

基本信息

Path: /seats/rename

Method: POST

接口描述:


Request

Headers

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

Body

参数名称参数类型是否必须示例备注
nametext是xxx坐席名称
clientidtext是xxx客户端ID

Reponse

{
   "code": 0,
   "message": "SUCCESS",
   "data": [],
   "category": "seats",
   "action": "rename"
}

坐席上线(websocket连接)

基本信息

Path: /

Method: GET

接口描述:

请求地址为客户端授权返回的wsserver

错误代码:

connection/group_limit_exceeded    // 超出坐席数限制

connection/authorize_fail    // 校验失败

client/client_not_registered   // 客户端未授权

client/clientid_was_empty     // clientid为空

Request

Headers

参数名称参数值是否必须示例备注
Authorization是Bearer xxxxxxxxxxx 为客户端授权返回的token
KAL-ClientID是xxxx设备ID

坐席下线

基本信息

Path: /seats/logout

Method: GET

接口描述:


Request

Headers

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

Query

参数名称是否必须示例备注
clientid是xxx
pcname否计算机名称

Reponse

{
  "code": 1504,
  "message": "SEATS_LOGOUT_FAILED",
  "data": {
      "tips": "努力奋斗的你,真好看"     // 下线提示语,为空则不显示
  },
  "category": "seats",
  "action": "logout"
}

坐席日志

基本信息

Path: /seat

Method: POST

接口描述:

坐席日志接口:http://sl-log.oray.net/seat

主控日志接口:https://oray.tudu.im/frame#m=view&tid=163ed84c8439ed53&page=1


1、事件名称(event)汇总:

坐席上线:seat_online

坐席下线:seat_offline

远程文件开始:file_start

远程文件结束:file_end

远程桌面观看开始:view_start

远程桌面观看结束:view_end

远程管理开始:manage_start

远程管理结束: manage_end



Request

Headers

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

Body

参数名称参数类型是否必须示例备注
eventtext是事件名称
clientidtext否52795c2d-7995-496c-aa1f-cf40af2a6c1c客户端ID
useridtext是904448用户ID
ctrl_systemtext否Windows主控端系统
ctrl_versiontext否10.2.3.456主控端版本
seat_nametext否采购部小黑坐席名称
fastcodetext否1234567899位快访码
memotext否远控信息
seatidtext否坐席ID
pcnametext否计算机名称

Reponse

{
   "code": 100,
   "channel": "seat",
   "message": "success"
}

客户端授权

基本信息

Path: /seats/authorization

Method: GET

接口描述:

客户端坐席上线都必须先经过此接口获取授权,授权后返回相关信息,客户端通过websocket连接在线服务


Request

Headers

参数名称参数值是否必须示例备注
Authorization是Bearer eyJ0eXAiOiJqd3QiLCJhbGciOiJSUzUxMiIsImtleWlkIjoiYzc3ZDcxMTdhM2ZiZmVmYjYzNTQ3ZjUzOTcxOTdkYTEifQ.eyJleHAiOjE1ODMzMTEwMDAsImlzYSI6MTU4MzMxMDk0MCwiaXNzIjoiUVJkMDkydzJHRUZjU0o2OW1Dd3IiLCJyb2xlIjo3LCJ1aWQiOiIyNCIsIm9yaSI6Il9fU1lTVEVNIn0

Query

参数名称是否必须示例备注
clientid是f4e2200f-e69f-4ae0-8524-e590f82e1ed1设备ID
name是xxx坐席名称,60个字节以内
mac是mac地址

Reponse

{
	"code": 0,
	"message": "SUCCESS",
	"data": {
		"token": "rquiFyKpg7ehRrVFcOr3AdYlxFHbZZmR",     // 客户端ws连接时用的token
		"wsserver": "http://112.124.5.13:8080",          // 客户端ws连接地址
		"tips": "美好的工作开始,又是元气满满的一天",    // 上线提示语,为空则不显示
		"retry_interval": 60                             // 重连长连接服务的间隔,单位秒
	},
	"category": "seats",
	"action": "authorization"
}

获取客户端状态

基本信息

Path: /seats/status

Method: GET

接口描述:


Request

Headers

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

Query

参数名称是否必须示例备注
clientid是f4e2200f-e69f-4ae0-8524-e590f82e1ed1

Reponse

{
	"code": 0,
	"message": "SUCCESS",
	"data": {
	    //坐席名称
	    "name": "liyt",  
	    //客户端是否在线
		"isonline": 0,
		// 在线数量
		"onlinenum": 0,
		// 坐席数量(未购买服务即返回0)
		"seatsnum": 5,
		// 可创建ID数,默认与购买数量一致
		"seatid_amount": 5, 
		//登录方式 1:账号密码 2:坐席ID
		"logintype":1,
		// 未购买坐席时广告语
		"freetext": "你是否从事远程支持?是否经常远程协助不同的用户?我们来帮你实现更快的远程支持工作",   
		// 未购买坐席时购买链接
		"freeurl": "https://store.oeay.com/buy/?productid=xxx",                             
		// 已购买坐席,未上线时广告语
		"paidofflinetext": "我是坐席未上线时的广告语",     
		// 已购买坐席,上后时广告语(目前没有,忽略)
		"paidonlinetext": "我是坐席上线后的广告语",            
		// 已购买坐席后,增加坐席链接
		"paidurl": "https://store.oeay.com/buy/?productid=xxx&action=upgrade",   
		// 坐席账号气泡
		"other_logintype_tips": "向日葵领航 · 坐席支持通过坐席ID方式登录上线,实现坐席员工区分管理,数据独立",             
		// 坐席账号气泡跳链
		"other_logintype_url": "https://store.oeay.com/buy/?productid=xxx&action=upgrade"
	},
	"category": "seats",
	"action": "status"
}

错误代码

基本信息

Path: /nil

Method: GET

接口描述:

错误代码 错误信息 
 1501 客户端授权失败
 1502 客户端ID为空
 1503 创建客户端分组失败
 1504 坐席下线失败
 1505 可用坐席数不足
 1506 更新坐席名称失败
 1507 坐席ID或密码错误
 1508 坐席不存在
 1509 删除星标快码失败
 1510 创建星标快码失败
 1511    星标数量已满
 1512 更新星标备注失败
 1513 限制mac地址登录
 1514 修改密码时,原坐席密码错误
 1515 修改密码失败
 1516 创建坐席远程记录失败
 1517 坐席已在别处登录
 1518 坐席服务过期/服务被删除
 1519 坐席已掉线(当前客户端没连上长连接)


Request

登录注册相关

发送验证码接口

基本信息

Path: /passport/send-verify-code

Method: GET

接口描述:

code:

1015 邮箱已注册

1520 该手机号已绑定多个坐席
1521 该手机号未绑定坐席

1522 当前登录方式为帐号登录,坐席ID和手机号不能登录

6001 xx秒后重试
6003 发送验证码失败
1011 邮箱格式错误

1012 邮箱为空

Request

Query

参数名称是否必须示例备注
action是newclientnewclient// 新设备登录提醒,seat // 坐席登录, register // 注册,seat_mobile_login // 坐席通过手机登录, oray-login // 免密登录,console-mobile //兼容平台短信验证
method是mobilemobile/email
target是10086电话号码或者邮箱
account否oraytest011帐号名
codetype是sms-短信 voice-语音 默认sms
checksum是验签
t是时间戳

Reponse

1、成功发送验证码
<?xml version="1.0" encoding="utf-8" ?>
<response>
<category>passport</category>
<action>sendverifycode</action>
<code>0</code>
<message>SUCCESS</message>
<datas/>
</response>

2、今天获取验证码次数已上限
<?xml version="1.0" encoding="utf-8" ?>
<response>
<category>passport</category>
<action>sendverifycode</action>
<code>6001</code>
<message>MOBILE_SEND_OUT_LIMIT</message>
<datas/>
</response>

3、系统错误、发送验证码失败
<?xml version="1.0" encoding="utf-8" ?>
<response>
<category>passport</category>
<action>sendverifycode</action>
<code>6003</code>
<message>SEND_VERIFYCODE_FAILED_1</message>
<datas/>
</response>
4、1分钟内只能发送1次验证码
<?xml version="1.0" encoding="utf-8" ?>
<response>
<category>passport</category>
<action>sendverifycode</action>
<code>6002</code>
<message>SEND_CODE_FAILED</message>
<datas/>
</response>

注册接口

基本信息

Path: /passport/register-account

Method: POST

接口描述:


Request

Headers

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

Body

参数名称参数类型是否必须示例备注
accounttext是
passwordtext是
checksumtext是md5()
versiontext是
clienttext是
mobiletext否
clientidtext否52795c2d-7995-496c-aa1f-cf40af2a6c1c/api/clientids下发的clientid
regtypetext否注册类型:0帐号注册,1手机注册,2邮箱注册,3无验证码帐号注册,4邮箱+验证码注册
emailtext否邮箱

Reponse

<?xml version="1.0" encoding="utf-8" ?>
<response>
<category>passport</category>
<action>registeraccount</action>
<code>0</code>
<message>SUCCESS</message>
<datas>
<datatype="field"name="userid">23638034</data>
</datas>
</response>

登录接口/passport/auth

<a id=登录接口/passport/auth>

基本信息

Path: /passport/auth

Method: POST

接口描述:

此接口POST/GET方式都兼容;

历史原因以前传递参数的时候传递了clientid。如果需要提供这个最新格式的clientid,又不想改到原来的代码,可以传递头部参数KAL-ClientID。
有头部参数KAL-ClientID,将会以此为准。

Request

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/x-www-form-urlencoded是
KAL-ClientIDfbe975a5-eb6d-4fb3-9c13-51f9f9a8f894是fbe975a5-eb6d-4fb3-9c13-51f9f9a8f894客户端ID

Body

参数名称参数类型是否必须示例备注
accounttext是
passwordtext是
clientidtext否fbe975a5-eb6d-4fb3-9c13-51f9f9a8f894

Reponse

<?xml version="1.0" encoding="utf-8" ?>
<response>
<category>passport</category>
<action>auth</action>
<code>0</code>
<message>SUCCESS</message>
<datas>
<datatype="field"name="userid">23168745</data>
<datatype="field"name="sysserviceid">0</data>
<datatype="field"name="servicename">免费级</data>
<datatype="field"name="amount">-1</data>
<datatype="field"name="price">-1</data>
<datatype="field"name="remotecount">0</data>
<datatype="field"name="recentcount">0</data>
<datatype="field"name="slapi">slapi.oray.net</data>
<datatype="field"name="skin">default</data>
<datatype="field"name="isgameservice">0</data>
<datatype="field"name="sysexpiredate"/>
<datatype="field"name="ismonitor">0</data>
<datatype="field"name="used">0</data>
<datatype="field"name="pubsvr"/>
<datatype="field"name="tracksrv"/>
<datatype="field"name="limit">5</data>
<datatype="field"name="retryafter">10</data>
<datatype="field"name="isnewclient">1</data> // 1是新设备。0不是新设备
<datatype="field"name="mobile">18217440106</data>// 返回的电话号码
<datatype="field"name="email">871321173@qq.com</data>// 返回的邮箱
</datas>
</response>

登录接口/passport/me

<a id=登录接口/passport/me>

基本信息

Path: /passport/me

Method: GET

接口描述:

历史原因以前传递参数的时候传递了clientid。如果需要提供这个最新格式的clientid,又不想改到原来的代码,可以传递头部参数KAL-ClientID。

有头部参数KAL-ClientID,将会以此为准。

Request

Headers

参数名称参数值是否必须示例备注
KAL-ClientID是fbe975a5-eb6d-4fb3-9c13-51f9f9a8f894客户端ID

Query

参数名称是否必须示例备注
account是oray.com
password是123123
clientid是fbe975a5-eb6d-4fb3-9c13-51f9f9a8f894

Reponse

<?xml version="1.0" encoding="utf-8" ?>
<response>
<category>passport</category>
<action>me</action>
<code>0</code>
<message>SUCCESS</message>
<datas>
<datatype="field"name="userid">23168745</data>
<datatype="field"name="nick"/>
<datatype="field"name="sysserviceid">0</data>
<datatype="field"name="servicename">免费级</data>
<datatype="field"name="amount">-1</data>
<datatype="field"name="price">-1</data>
<datatype="field"name="remotecount">0</data>
<datatype="field"name="recentcount">0</data>
<datatype="field"name="slapi">slapi.oray.net</data>
<datatype="field"name="skin">default</data>
<datatype="field"name="isgameservice">0</data>
<datatype="field"name="sysexpiredate"/>
<datatype="field"name="ismonitor">0</data>
<datatype="field"name="used">0</data>
<datatype="field"name="pubsvr"/>
<datatype="field"name="tracksrv"/>
<datatype="field"name="account">vp-youuserna-305</data>
<datatype="field"name="isabroaduser">0</data>
<datatype="field"name="mobile">18217440106</data>
<datatype="field"name="email">871321173@qq.com</data>
<datatype="field"name="isnewclient">0</data> // 1新设备,0不是新设备
</datas>
</response>

验证码接口

基本信息

Path: /passport/verify

Method: GET

接口描述:


Request

Query

参数名称是否必须示例备注
method是mobile
value是123456验证码
account是orayoray账号
clientid否52795c2d-7995-496c-aa1f-cf40af2a6c1cclientid
action是newclientnewclient // 新设备,seat // 坐席登录,register // 注册,console-mobile //兼容平台短信验证

Reponse

1、验证成功:
<?xml version="1.0" encoding="utf-8" ?>
<response>
<category>passport</category>
<action>verify</action>
<code>0</code>
<message>SUCCESS</message>
<datas>
<datatype="field"name="token">grmT8HHmNZC2DQfm1wE3TsvPcPGfarPq</data>
<datatype="field"name="timeout">1583808777</data>
</datas>
</response>
2、验证失败
<?xml version="1.0" encoding="utf-8" ?>
<response>
<category>passport</category>
<action>verify</action>
<code>6014</code>
<message>INVALID_VERIFY_CODE</message>
<datas/>
</response>

插座/排插

wifi

基本信息

Path: /smart-plug/wifi

Method: POST

接口描述:


Request

Headers

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

Body

参数名称参数类型是否必须示例备注
sntext是
ssidtext是
passwordtext是
prototext是从这开始 pdu特有
ipv4text是
netmasktext是
gatewaytext是
dnstext是

删除定时

基本信息

Path: /smart-plug/delete-timer

Method: GET

接口描述:


Request

Headers

参数名称参数值是否必须示例备注
AuthorizationBearer eyJhbGciOiJIUzUxMiIsInIiOjI4Nzk5OTE1NTIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MjEzOTc2MDcsImlzYSI6MTYyMTM5NTgwNywiaXNzIjoib3JheXRlc3QwMTIiLCJyb2xlIjo0LCJ1aWQiOjEyNTY0MTIyLCJzZXIiOiJhdXRoLXdlYi5vcmF5Lm5ldCIsIm5zIjoidXNlciJ9.UwJQ67s80M10QEl-MJ_tojvd8S9L8GrmjvYQuvV1DaeYkSqpHbBGzSvRtytwP9dOScuiub2xxWvp8KD2mOHM8w是

Query

参数名称是否必须示例备注
sn是000000888888
inder是1插孔序列号,此字段命名为了与RPC接口定义一致
timer是2020-07-23 15:20:25

升级状态

基本信息

Path: /smart-plug/upgrade-status

Method: GET

接口描述:


Request

Query

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

定时执行状态变更

基本信息

Path: /smart-plug/countdown

Method: GET

接口描述:


Request

Query

参数名称是否必须示例备注
sn是000000888888
remoteid是12
action是off
seconds是1
index是插孔序列号,此字段命名为了与RPC接口定义一致

插座/排插新增日志

<a id=插座/排插新增日志>

基本信息

Path: /smartplug

Method: GET

接口描述:

请求:sl-log.oray.net/smartplug

host: 192.168.30.227 sl-log.oray.net

-----为了兼容排插,本次增加type和index参数------

-----以下参数已经在插座日志已使用。不再赘述-------

参数:

sn
userid 用户ID
account 用户名
action 事件(详细解释在下面)
remoteid 主机ID (可选,绑定主机失败时传)
remoteip 主机IP (可选,绑定主机失败时传)
upgrade_romversion 升级的固件新版本 (可选,升级固件失败时传)
romversion 当前固件版本 (可选,升级固件失败、插座连接不上网络时传)
remotename 主机名称 (可选,绑定主机失败时传)
reason 错误原因(中文)
code 错误代码(网站接口返回的代码,reason和code两个参数必须传一个)
url 主控端请求网站的接口地址

action:
ADD_F // 添加插座失败
BIND_F // 绑定主机失败
UPROM_F // 升级固件失败
CONNECT_F // 插座连接不上网络
ENTER_F // 无法进入插座主界面
POWERON_F // 开启插座失败
SHUTDOWN_F // 关闭插座失败
COUNT_F // 倒计时失败
SETTIMER_F // 定时失败
RENAME_F // 插座重命名失败

GETTIMER_F // 获取定时失败 

Request

Query

参数名称是否必须示例备注
type否10type// 10 - 代表排插;不传就是插座
index否0排插插孔号;0-3;插座不传

Reponse

{
   "code": 100,
   "channel": "smartplug",
   "message": "success"
}

更新插座

基本信息

Path: /smart-plug/update

Method: GET

接口描述:


Request

Query

参数名称是否必须示例备注
sn是000000888888
time是1626746872
mac是84:f3:eb:cf:5f:ab
key是a4f92646520f74a25c09324f6f166c2a
version是1.0.1

检查升级

基本信息

Path: /smart-plug/upgrade

Method: GET

接口描述:


Request

Headers

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

Query

参数名称是否必须示例备注
sn是插座(排插)sn
_format否json返回格式,默认返回xml
version否当前版本,接口会rpc请求插座查当前版本,查不到的话,会用当前这参数

Reponse

{
	"code": 0,
	"message": "SUCCESS",
	"data": {
		"isupgrade": 1,          // 是否能升级
		"latest": "1.2.0",       // 最新版本号
		"model": "C1",           // 插座/排插型号
		"downloadurl": "http://download-backend.oray.com/sunlogin/smartplug/1.2.0/",    // 升级地址
		"isforce": 0,            // 是否强制升级
		"description": "描述",   // 升级版本描述
		"md5": "r348rfu3498ff"   // 包的md5值
	},
	"category": "smartplug",
	"action": "upgrade"
}

添加定时

基本信息

Path: /smart-plug/set-timer

Method: GET

接口描述:


Request

Headers

参数名称参数值是否必须示例备注
AuthorizationBearer eyJhbGciOiJIUzUxMiIsInIiOjI4Nzk5OTE1NTIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MjEzOTc2MDcsImlzYSI6MTYyMTM5NTgwNywiaXNzIjoib3JheXRlc3QwMTIiLCJyb2xlIjo0LCJ1aWQiOjEyNTY0MTIyLCJzZXIiOiJhdXRoLXdlYi5vcmF5Lm5ldCIsIm5zIjoidXNlciJ9.UwJQ67s80M10QEl-MJ_tojvd8S9L8GrmjvYQuvV1DaeYkSqpHbBGzSvRtytwP9dOScuiub2xxWvp8KD2mOHM8w是

Query

参数名称是否必须示例备注
sn是000000888888
inder是1插孔序列号,此字段命名为了与RPC接口定义一致
timer是2020-07-23 15:20:25

移除已添加的定时器

基本信息

Path: /smart-plug/delete-countdown

Method: GET

接口描述:


Request

Headers

参数名称参数值是否必须示例备注
AuthorizationBearer eyJhbGciOiJIUzUxMiIsInIiOjI4Nzk5OTE1NTIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MjEzOTc2MDcsImlzYSI6MTYyMTM5NTgwNywiaXNzIjoib3JheXRlc3QwMTIiLCJyb2xlIjo0LCJ1aWQiOjEyNTY0MTIyLCJzZXIiOiJhdXRoLXdlYi5vcmF5Lm5ldCIsIm5zIjoidXNlciJ9.UwJQ67s80M10QEl-MJ_tojvd8S9L8GrmjvYQuvV1DaeYkSqpHbBGzSvRtytwP9dOScuiub2xxWvp8KD2mOHM8w是

Query

参数名称是否必须示例备注
sn是000000888888
remoteid是1
index是1插孔序列号,此字段命名为了与RPC接口定义一致

绑定

基本信息

Path: /smart-plug/add

Method: POST

接口描述:


Request

Headers

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

Body

参数名称参数类型是否必须示例备注
sntext是sn码
nametext是备注
descriptiontext否描述
_formattext否json返回数据格式,默认xml

Reponse

{
    "code": 0,
    "message": "",
    "data": {
        "server": "",
        "port": "",
        "model": "P5",
        "password": "", // mqtt协议所需密码,aes-cbc加密,key为sn,前16位字符,不够位右边补6,iv为服务代码userid,前16位,不够位右边补6
    }
}

绑定主机

基本信息

Path: /smart-plug/bind

Method: POST

接口描述:

兼容POST和GET方式

Request

Headers

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

Body

参数名称参数类型是否必须示例备注
remoteidtext是主机ID
sntext是硬件SN
indextext是插孔序列号0-3 // 插座不需要传

获取定时器

基本信息

Path: /smart-plug/get-countdown

Method: GET

接口描述:


Request

Headers

参数名称参数值是否必须示例备注
AuthorizationBearer eyJhbGciOiJIUzUxMiIsInIiOjI4Nzk5OTE1NTIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MjEzOTc2MDcsImlzYSI6MTYyMTM5NTgwNywiaXNzIjoib3JheXRlc3QwMTIiLCJyb2xlIjo0LCJ1aWQiOjEyNTY0MTIyLCJzZXIiOiJhdXRoLXdlYi5vcmF5Lm5ldCIsIm5zIjoidXNlciJ9.UwJQ67s80M10QEl-MJ_tojvd8S9L8GrmjvYQuvV1DaeYkSqpHbBGzSvRtytwP9dOScuiub2xxWvp8KD2mOHM8w是

Query

参数名称是否必须示例备注
sn是000000888888
remoteid是1
index是1插孔序列号,此字段命名为了与RPC接口定义一致

获取插座/排插开关日志

<a id=获取插座/排插开关日志>

基本信息

Path: /smart-plug/get-status-logs

Method: GET

接口描述:


Request

Query

参数名称是否必须示例备注
sn是000000888888
page是1
pagesize是20

获取插座安全协议

基本信息

Path: /smart-plug/get-agree-protocol

Method: GET

接口描述:







Request

Query

参数名称是否必须示例备注
model否P1排插 // P1 - 排插。不传就是普通插座

Reponse

<?xml version="1.0" encoding="utf-8" ?>
<response>
<category>smartplug</category>
<action>getagreeprotocol</action>
<code>0</code>
<message>SUCCESS</message>
<datas>
<datatype="field"name="isagree">1</data>
</datas>
</response>

// json
{
"code": 0,
"message": "SUCCESS",
"data":{
"isagree": 1
},
"category": "smartplug",
"action": "getagreeprotocol"
}

获取插座状态

基本信息

Path: /smart-plug/status

Method: GET

接口描述:


Request

Query

参数名称是否必须示例备注
sn是000000888888
remoteid是1

获取插座用户列表

基本信息

Path: /smart-plug/list

Method: GET

接口描述:


Request

Headers

参数名称参数值是否必须示例备注
AuthorizationBearer eyJhbGciOiJIUzUxMiIsInIiOjI4Nzk5OTE1NTIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MjEzOTc2MDcsImlzYSI6MTYyMTM5NTgwNywiaXNzIjoib3JheXRlc3QwMTIiLCJyb2xlIjo0LCJ1aWQiOjEyNTY0MTIyLCJzZXIiOiJhdXRoLXdlYi5vcmF5Lm5ldCIsIm5zIjoidXNlciJ9.UwJQ67s80M10QEl-MJ_tojvd8S9L8GrmjvYQuvV1DaeYkSqpHbBGzSvRtytwP9dOScuiub2xxWvp8KD2mOHM8w是

Query

参数名称是否必须示例备注
sn是000000888888
remoteid是1
index是1插孔序列号,此字段命名为了与RPC接口定义一致

获取版本

基本信息

Path: /smart-plug/version

Method: POST

接口描述:


Request

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/x-www-form-urlencoded是
AuthorizationBearer eyJhbGciOiJIUzUxMiIsInIiOjI4Nzk5OTE1NTIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MjEzOTc2MDcsImlzYSI6MTYyMTM5NTgwNywiaXNzIjoib3JheXRlc3QwMTIiLCJyb2xlIjo0LCJ1aWQiOjEyNTY0MTIyLCJzZXIiOiJhdXRoLXdlYi5vcmF5Lm5ldCIsIm5zIjoidXNlciJ9.UwJQ67s80M10QEl-MJ_tojvd8S9L8GrmjvYQuvV1DaeYkSqpHbBGzSvRtytwP9dOScuiub2xxWvp8KD2mOHM8w是

Body

参数名称参数类型是否必须示例备注
sntext是000000888888

获取电量信息

基本信息

Path: /smart-plug/get-electric

Method: GET

接口描述:


Request

Query

参数名称是否必须示例备注
sn是000000888888
dete否2021-07-20 17:28:40
time是1629410400所在地0点的时间戳

解绑主机

基本信息

Path: /smart-plug/unbind

Method: POST

接口描述:

兼容POST与GET方式

Request

Headers

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

Body

参数名称参数类型是否必须示例备注
remoteidtext是主机ID
sntext是SN
indextext是插孔序列号

设置同意安全协议

基本信息

Path: /smart-plug/set-agree-protocol

Method: GET

接口描述:


Request

Query

参数名称是否必须示例备注
model否P1排插 // P1 - 排插。不传就是普通插座
isagree是1

设置延迟关闭电源

基本信息

Path: /smart-plug/set-delay

Method: GET

接口描述:

兼容GET/POST方式

Request

Query

参数名称是否必须示例备注
sn是912345678813插座SN
delay是120延迟时间 // 请传秒
index否0插孔号

设置指示灯开关

基本信息

Path: /smart-plug/set-led

Method: GET

接口描述:


Request

Query

参数名称是否必须示例备注
sn是000000888888
remoteid是1
status是1

设置插孔备注

基本信息

Path: /smart-plug/set-socket-memo

Method: GET

接口描述:

备注不允许超过20个字符。一个中文只算一个字符。

Request

Query

参数名称是否必须示例备注
memo是S1插孔备注
index是0S1-S4
sn是987654321插线板SN

Reponse

<?xml version="1.0" encoding="utf-8" ?>
<response>
<category>smartplug</category>
<action>setsocketmemo</action>
<code>3007</code>
<message>Memo too long</message>
<datas/>
</response>

// JSON

{
"code": 3007,
"message": "Memo too long",
"data":[],
"category": "smartplug",
"action": "setsocketmemo"
}

设置断电记忆开关

基本信息

Path: /smart-plug/set-outage-memory

Method: GET

接口描述:


Request

Query

参数名称是否必须示例备注
sn是000000888888
remoteid是1
status是1

重命名

基本信息

Path: /smart-plug/rename

Method: GET

接口描述:


Request

Query

参数名称是否必须示例备注
sn是000000888888
name是test
description是别管我

长连接通知

发布主机备注名消息(开发调试用)

基本信息

Path: /notify/pub-remote-info

Method: GET

接口描述:


Request

Query

参数名称是否必须示例备注
userid是用户id
orgname是原主机名
name是新主机名
orgdesc是原备注
desc是新备注
remoteid是主机id

Reponse

OK

发布主机状态消息(开发调试用)

基本信息

Path: /notify/pub-remote-state

Method: GET

接口描述:


Request

Query

参数名称是否必须示例备注
userid是用户id
name是主机名
state是状态,1上线,0下线
remoteid是主机id

Reponse

OK

授权

基本信息

Path: /notify/authorization

Method: GET

接口描述:


Request

Headers

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

Query

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

Reponse

<?xml version="1.0" encoding="utf-8"?>
<response>
    <category>notify</category>
    <action>authorization</action>
    <code>0</code>
    <message>SUCCESS</message>
    <datas>
        <data  type="field" name="token">igL77XomIa3bp0GQCu7YKeIgJWEg2HeA</data>
        <data  type="field" name="wsserver">wss://kal.oray.com/</data>
    </datas>
</response>

坐席2.0

修改坐席密码

基本信息

Path: /seats/alter-psw

Method: POST

接口描述:


Request

Headers

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

Body

参数名称参数类型是否必须示例备注
prepasswordtext是4297f44b13955235245b2497399d7a93旧密码(md5后的32位小写)
passwordtext是e10adc3949ba59abbe56e057f20f883e新密码(md5后的32位小写)

创建远程记录

基本信息

Path: /seats/history-create

Method: POST

接口描述:

event取值:

坐席上线:login

坐席下线:logout

远程文件:file

远程桌面观看:view

远程管理:manage

远程控制:remote

手工加远程记录:note

cmd:cmd/cmd2

ssh:ssh


Request

Headers

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

Body

参数名称参数类型是否必须示例备注
fastcodetext否168520365识别码
eventtext是view事件名

Reponse

{
	"code": 0,
	"message": "SUCCESS",
	"data": {
		"id": 8     // 远程记录id,更新远程记录时需要带上
	},
	"category": "seats",
	"action": "historycreate"
}

取消星标快访码

基本信息

Path: /seats/like-delete

Method: POST

接口描述:


Request

Headers

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

Body

参数名称参数类型是否必须示例备注
fastcodetext是快访码

Reponse

<?xml version="1.0" encoding="utf-8"?>
<response>
    <category>seats</category>
    <action>likecreate</action>
    <code>0</code>
    <message>SUCCESS</message>
    <datas>
    </datas>
</response>

坐席获取token

基本信息

Path: /seats/token

Method: GET

接口描述:

返回参数解析:

retry_interval 长连接重连间隔,单位秒

wsserver 长连接服务器

kal_token 长连接token

account 帐号名

seatname 坐席名

错误码:

1505 可用坐席数不足(剩余坐席上线数是否<购买的坐席数)

1520 该手机号已绑定多个坐席

1521 该手机号未绑定坐席

1522 当前登录方式为帐号登录,坐席ID和手机号不能登录

6014 验证码错误

Request

Query

参数名称是否必须示例备注
seatid否12500512:7776坐席ID登录时传
password否e10adc3949ba59abbe56e057f20f883e坐席密码,md5后
mac是00:00:00:00:00:00mac
lang是zh_CN语言
clientid是1bdd00c0-15c1-4d3d-8018-7f23ebfc0174
mobile否13500001111手机号登录坐席时传
code否123456手机号登录坐席时传

Reponse

{
  "code": 0,
  "message": "SUCCESS",
  "data": {
    "seatid": "supp123456",
    "mobile": "13590640943",
    "account": "yoontyaw",
    "ismobileverify_login": 0,
    "inspire_tips": "美好的工作开始,又是元气满满的一天",
    "userid": 12500512,
    "seatname": "好",  // 如为空则为首次登录
    "access_token": "eyJhbGciOiJIUzUxMiIsInIiOjI2OTU5NjE0MTYsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MDM3ODIyOTUsImlzYSI6MTYwMzc4MTM5NSwiaXNzIjoiMTI1MDA1MTI6NzkzOSIsInJvbGUiOjMsInVpZCI6MTI1MDA1MTIsInNlciI6ImF1dGgtc2wub3JheS5jb20iLCJucyI6InN1bmxvZ2luX3NlYXQifQ.AdYwWiuU4K8mGdOhng4WuoiMNJGcewVrHJgA9KAr3qbG3lQWkksY-Srr50c46K37YvpaEZY7uB1wgDX2WSAVtA",
    "refresh_token": "X5fDE1+/UBMAAAAUZ1h1ZldIY2JkajJ6QTJReUh2UUE1NUVZMHBLazBiRXBtNWQ4UGxUNU13PT0=",
    "refresh_expires": 1606373395,
    "refresh_ttl": 2592000,
    "retry_interval": 60,
    "wsserver": "ws://kal.sunlogin.oray.com/",
    "kal_token": "tbSeFI4nmoMt97Isj77XEVpVMTpzxxYd",
    "default_online": true   // true默认上线坐席,false不上线
  },
  "category": "seats",
  "action": "token"
}

新增星标快访码/修改备注

<a id=新增星标快访码/修改备注>

基本信息

Path: /seats/like-create

Method: POST

接口描述:


Request

Headers

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

Body

参数名称参数类型是否必须示例备注
fastcodetext是快访码
memotext是备注

Reponse

<?xml version="1.0" encoding="utf-8"?>
<response>
    <category>seats</category>
    <action>likecreate</action>
    <code>0</code>
    <message>SUCCESS</message>
    <datas>
    </datas>
</response>

星标列表

基本信息

Path: /seats/like-list

Method: GET

接口描述:

os:

windows

android

linux

mac

ios

Request

Headers

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

Reponse

{
   "code": 0,
   "message": "SUCCESS",
   "data": [
      {
         "fastcode": "123456789",
         "memo": null,
         "os": "windows"
      }
   ],
   "category": "seats",
   "action": "likelist"
}

更新远程记录

基本信息

Path: /seats/history-update

Method: POST

接口描述:

event取值: 

填入结束时间:end 

填入备注:writememo

Request

Headers

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

Body

参数名称参数类型是否必须示例备注
idtext是1远程记录id,创建远程记录时会返回
memotext否远程记录备注
eventtext是view操作标识。标识更新记录的结束时间,或写备注
fastcodetext是识别码

根据帐号token获取坐席token

基本信息

Path: /seats/auth-account

Method: GET

接口描述:

错误码:

1518 坐席服务过期

Request

Query

参数名称是否必须示例备注
clientid是4ba37eb5-af6a-4eec-aae6-0de73a7e2434设备id
mac是mac

Reponse

{
   "code": 0,
   "message": "SUCCESS",
   "data": {
      "access_token": "eyJhbGciOiJIUzUxMiIsInIiOjEwNTk0MjYzNSwidHlwIjoiSldUIn0.eyJleHAiOjE2MTgyMzM5NjIsImlzYSI6MTYxODIzMzA2MiwiaXNzIjoiMTI1MDA1MTI6Mzc2OCIsInJvbGUiOjMsInVpZCI6MTI1MDA1MTIsInNlciI6ImF1dGgtc2wub3JheS5jb20iLCJucyI6InN1bmxvZ2luX3NlYXQifQ.Ev4E_gwqFgOt6aJCLa7bbbYKfTZks2XbYGu7357WKcuKaubzNnHo6NDoc_Y91Jah0wRs6lSvyb8CPFaupSwnCQ",
      "refresh_token": "YHRG5mCb0+YAAAAUZ1h1ZldIY2JkajJ6QTJReUh2UUFrMUpzbXRLUTNuaVlFNjBxKzVJUU1nPT0=",
      "refresh_expires": 1620825062,
      "refresh_ttl": 2592000
   },
   "category": "seats",
   "action": "authaccount"
}

获取远程记录

基本信息

Path: /seats/history-list

Method: GET

接口描述:


Request

Headers

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

Query

参数名称是否必须示例备注
fastcode是123456789被控的快码

Reponse

{
	"code": 0,
	"message": "SUCCESS",
	"data": [
		{
			"starttime": "1602664520",
			"endtime": "1602664524",
			"event": "remote",
			"memo": "123456"
		},
		{
			"starttime": "1602664132",
			"endtime": "1602664136",
			"event": "remote",
			"memo": "啥也没干,哈哈哈哈"
		},
	],
	"category": "seats",
	"action": "historylist"
}

验证坐席ID密码

基本信息

Path: /seats/verify

Method: POST

接口描述:


Request

Headers

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

Body

参数名称参数类型是否必须示例备注
seatidtext是12500512:7939坐席ID
passwordtext是e10adc3949ba59abbe56e057f20f8831md5后的密码

桌面直播

开始直播

基本信息

Path: /live/start

Method: POST

接口描述:


Request

Headers

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

Body

参数名称参数类型是否必须示例备注
codetext是27d2-0bd4-e126-72ee授权码(即客户端配置里的license)
authtext是授权码的密码(即客户端配置里的licensepsw)
pswtext是4297f44b13955235245b2497399d7a93直播间密码,md5加密
durationtext否直播时长
auth_keytext是md5('SUNLOGIN_LIVE'+授权码+timestamp)
timestamptext是时间戳

Reponse

{
	"code": 0,
	"message": "SUCCESS",
	"data": {
		"push_domain": "push.sunlogin.oray.com",           // 推流域名
		"appname": "live",                                 // 应用名
		"share_url": "https://sunlogin.oray.com/live/xxx", // 分享链接
		"streamname": "d482d134fb56c963142a5373d0b4512d",  // 流名称
		"stream_ts": 1621397203                            // 流时间戳,用于鉴权串
	},
	"category": "live",
	"action": "start"
}

结束直播

基本信息

Path: /live/end

Method: POST

接口描述:


Request

Headers

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

Body

参数名称参数类型是否必须示例备注
codetext是27d2-0bd4-e126-72ee授权码
authtext是授权码的密码
timestamptext是时间戳
auth_keytext是md5('SUNLOGIN_LIVE'+授权码+timestamp)
streamnametext是流名称

Reponse

{
   "code": 0,
   "message": "SUCCESS",
   "data": [],
   "category": "live",
   "action": "end"
}

领航版

获取targetid

基本信息

Path: /rongyun/getTargetid

Method: POST

接口描述:


Request

Headers

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

Body

{
        "device_uniq": "dhfduikwskkd" // [仅被控端app] 绑定设备id和快码关系
	"fastcode": "122222" // [主控端&被控端传递]:快码用于获取被控slave_chatid
        "master_uid": "33333" //[仅主控端传递]: 网站uid,用户获取master_chatid
}

Reponse

{
    "code": 200,
    "slave_fastcode":"912345678", // 被控端快码
    "slave_chatid": "b59c67bf196a4758191e42f76670ceba", // 被控端融云id
    "master_chatid": "33333", //主控端融云id,主控端用于传递给js, APP端,不使用该字段
    "device_uniq":"dhfduikwskkd" // 设备id
}

获取token

基本信息

Path: /rongyun/getToken

Method: POST

接口描述:

application/json  

Request

Headers

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

Body

{
	"chatid": "111111", // win客户端传向日葵userid,app传 '获取targetid接口' 返回的slave_chatid
	"name": "122222", //名称
	"portraitUri": ""//头像url
}

Reponse

{
   "code": 200,
   "chatid": "1111",
   "token": "ccisQd9DZ9eYSeh8XCV167/FmlIYp5sJ3qTo2RZK1Oo=@9njf.cn.rongnav.com;9njf.cn.rongcfg.com"
}

云键盘

云键盘-列表

基本信息

Path: /keyboard/list

Method: POST

接口描述:


Request

Headers

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

Body

参数名称参数类型是否必须示例备注
tabtext是1tab分类 1,最近使用 2,官方推荐 3,网友分享 4,我的键盘
keyboardnametext否键盘名称模糊搜索
typetext否键盘分类 0,角色扮演 1, 动作, 2,射击 3,策略 4,赛车, 5,其他
iscollecttext否tab为4时, 传参1, 返回我的键盘-收藏
sorttext否likes, used, collect, newest 点赞,使用,收藏,最新 倒序
pagetext否页码 默认1
pagesizetext否页条数 默认10条

Reponse

{
    "code": 0,
    "message": "SUCCESS",
    "data": {
        "page": 1,  //当前页码
        "totalpage": 1, //总页数
        "totallist": 1, //总数据条数
        "list": [
            {
                "cloudid": "11_0", //键盘云id,唯一
                "keyboardid": 8, //键盘id
                "userid": 12564199, //用户id
                "typeid": 1, //分类id
                "name": "lol", //键盘名称
                "img": "test.png", //键位绘制图
                "likes": 0, //点赞数
                "collect": 0, //收藏数
                "used": 0, //使用数
                "isofficial": 0, //是否官方 0,否 1,是
                "equipment": 1, //适用设备  1,phone  2,pad
                "isshare": 1, //是否分享 0,否 1,是
                "isused": 0, //是否使用过 0,否 1,是
                "islike": 0, //是否点赞 0,否 1,是
                "iscollect": 0, //是否收藏 0,否 1,是
                "iscancel": 1, //分享是否已取消
                "isself": 1, //是否自己创建 0,否 1,是
                "createtime": "2021-04-08 11:05:02",
                "createtime_timestamp": 1617851102
            }
        ]
    },
    "category": "keyboard",
    "action": "list"
}

云键盘-创建

基本信息

Path: /keyboard/create

Method: POST

接口描述:


Request

Headers

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

Body

参数名称参数类型是否必须示例备注
keyboardnametext是键盘名称
configtext是键位配置
typetext是键盘类型
equipmenttext是设备 1,phone 2,pad
issharetext否0,否 1,是
issynctext否1是否云同步 1:是

Reponse

// code:1004 参数缺少
//code:1002 参数有误


{
    "code": 0,
    "message": "SUCCESS",
    "data": {
        "cloudid": "11_0", //键盘云id
        "uploadurl": null //图片上传url
    },
    "category": "keyboard",
    "action": "create"
}

云键盘-删除

基本信息

Path: /keyboard/delete

Method: POST

接口描述:


Request

Headers

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

Body

参数名称参数类型是否必须示例备注
cloudidtext是键盘云id

云键盘-操作(点赞,收藏,分享,使用)

基本信息

Path: /keyboard/setting-lusc

Method: POST

接口描述:


Request

Headers

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

Body

参数名称参数类型是否必须示例备注
cloudidtext是键盘云id
settingtext是操作类型 1,点赞 2,使用 3,分享 4,收藏
iscanceltext否1是否取消 1,是 收藏&分享&使用可传参

云键盘-敏感词过滤

基本信息

Path: /keyboard/sensitive-filter

Method: POST

接口描述:


Request

Headers

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

Body

参数名称参数类型是否必须示例备注
keyboardnametext是键盘名称

Reponse

//存在敏感词
{
  "code": 7102,
  "message": "SENSITIVE WORDS [淫]",
  "data": [],
  "category": "keyboard",
  "action": "sensitivefilter"
}

云键盘-更新

基本信息

Path: /keyboard/update

Method: POST

接口描述:


Request

Headers

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

Body

参数名称参数类型是否必须示例备注
cloudidtext是键盘云id
keyboardnametext否键盘名称
typetext否键盘分类 0,角色扮演 1, 动作, 2,射击 3,策略 4,赛车, 5,其他
configtext否配置
equipmenttext否适用设备 1,phone 2,pad
issharetext否是否分享 0,否 1,是

Reponse

{
    "code": 0,
    "message": "SUCCESS",
    "data": {
        "cloudid": "11_0", //键盘云id
        "uploadurl": null //图片上传url
    },
    "category": "keyboard",
    "action": "update"
}

云键盘-键盘详情

基本信息

Path: /keyboard/info

Method: POST

接口描述:

Request

Headers

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

Body

参数名称参数类型是否必须示例备注
cloudidtext是键盘云id
isusetext否1是否使用 0,否 1,是

Reponse

{
"code": 0,
"message": "SUCCESS",
"data": {
//键盘云id
"cloudid": "11_0",
//键盘id
"keyboardid": 11, 
 //用户id
"userid": 12564122,
//分类id
"typeid": 1,  
//键盘名称
"name": "LOL", 
//键盘配置
"config": "",  
//键位绘制图
"img": "",   
//点赞数
"likes": 0,
//收藏数
"collect": 0, 
//使用数
"used": 0, 
//是否官方
"isofficial": 0, 
//适用设备 1,phone  2,pad
"equipment": 1, 
//是否分享 0,否 1,是
"isshare": 1, 
//是否点赞 0,否 1,是
"islikd": 1, 
//是否使用 0,否 1,是
"isused": 1, 
//是否收藏 0,否 1,是
"iscollect": 1, 
//是否取消分享 0,否 1,是
"iscancel": 1, 
//是否自己创建 0,否 1,是
"isdelete": 1, 
//键盘创建时间
"createtime": "2021-04-08 13:29:37",
//键盘创建时间戳
"createtime_timestamp": 1617859777
},
"category": "keyboard",
"action": "info"
}

错误代码

基本信息

Path: /keyborad/nil

Method: GET

接口描述:


 错误代码错误信息
 备注
 7101 键盘不存在 
 7102 键盘名称有误/存在敏感词 
 7111 已点赞 
 7112 不允许收藏自建键盘 
 7113 已收藏 
 7114 已分享 
 7115 收藏记录不存在 
 7116 已取消分享 
 7117 未分享 无法点赞/收藏/使用 
 7118 cloud_id有误 
 7119 使用记录不存在 
 7120 自建键盘名字重复 
   
   
   
   
   
   
   



Request

IT 资产

提交资产变动信息

基本信息

Path: /resource/change

Method: POST

接口描述:

错误码:

1004 缺少必要参数

Request

Headers

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

Body

参数名称参数类型是否必须示例备注
codetext是授权码
authtext是授权码密码
ostext是系统
cputext是cpu(可能存在多个,json格式提交)
mainboardtext是主板(可能存在多个,json格式提交)
memory_sizetext是102400MB内存大小
keyboardtext是键盘(可能存在多个,json格式提交)
videocardtext是显卡(可能存在多个,json格式提交)
networkcardtext是网卡(可能存在多个,json格式提交)
monitortext是显示器(可能存在多个,json格式提交)
maindisktext是硬盘信息(可能存在多个,json格式提交)
mactext是mac
os_typetext是系统类型 windows,android,linux,macOS

Reponse

{
   "code": 0,
   "message": "SUCCESS",
   "data": [],
   "category": "resource",
   "action": "change"
}

开机棒/开机盒子

开机盒子绑定接口

基本信息

Path: /sunlogin/device-box-add

Method: POST

接口描述:

注意:采用验证码方式的话,请走原绑定接口(开机棒)不用此接口

1、加密规则:

对 sn、user_id、name、_t为键值的数组进行ksort(对关联数组按照键名进行升序排序)后 ,以英文逗号 , 将数组变成字符串,加上密钥后md5

php如:

const SECRET_KEY = '+=kaijihezi-add=+'; // 密钥

ksort($param);

$sign = md5(implode(',',$param ) . self::SECRET_KEY)


2、错误码

1 => '失败'

2 => '验证无效'

5 =>'参数有误'

1209 => '设备不存在'

...

注(其余可以看message,code=>message)

Request

Headers

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

Query

参数名称是否必须示例备注
sn是03677568852开机盒序列号
user_id是1用户id
_t是1619069826当前提交time()时间 (防超时)
sign是a49e1fd411628117c2710b1581e184a4加密后的密钥(MD5)
name是开机盒子开机盒子名称

Reponse

{
    "code": 0,
    "message": "SUCCESS",
    "data": {
        "deviceid": 123,
    },
    "category": "sunlogin",
    "action": "device-box-add"
}

开机盒子解绑接口

基本信息

Path: /wakeup/box-delete

Method: POST

接口描述:

注意:采用验证码方式的话,请走原解绑接口(开机棒)不用此接口

1、加密规则:

对 sn、user_id、_t为键值的数组进行ksort(对关联数组按照键名进行升序排序)后 ,以英文逗号 , 将数组变成字符串,加上密钥后md5

php如:

const SECRET_KEY = '+=kaijihezi-delete=+'; // 密钥

ksort($param);

$sign = md5(implode(',',$param ) . self::SECRET_KEY)


2、错误码

1 => '失败'

2 => '验证无效'

5 =>'参数有误'

1209 => '设备不存在'

...

注(其余可以看message,code=>message)

Request

Headers

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

Query

参数名称是否必须示例备注
sn是03677568852开机盒序列号
user_id是1用户id
_t是1619069826当前提交time()时间 (防超时)
sign是a49e1fd411628117c2710b1581e184a4加密后的密钥(MD5)

Reponse

{
   "code": 0,
   "message": "SUCCESS",
   "data": {},
   "category": "sunlogin",
   "action": "device-box-delete"
}

记录开机棒/开机盒子激活时间

<a id=记录开机棒/开机盒子激活时间>

基本信息

Path: /sunlogin/record-wakeup-time

Method: POST

接口描述:

1、加密规则:

对 sn、uptime、description、_t为键值的数组进行ksort(对关联数组按照键名进行升序排序)后 ,以英文逗号 , 将数组变成字符串,加上密钥后md5

php如:

const SECRET_KEY = '+=huashengkui=+'; // 密钥

ksort($param);

$sign = md5(implode(',',$param ) . self::SECRET_KEY)


2、错误码

1 => '失败'

2 => '验证无效'

5 =>'参数有误'

1209 => '设备不存在'

Request

Headers

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

Query

参数名称是否必须示例备注
sn是03677568852开机盒序列号
uptime是2021-04-22 13:45:17激活时间
_t是1619069826当前提交time()时间 (防超时)
sign是a49e1fd411628117c2710b1581e184a4加密后的密钥(MD5)

Reponse

{
   "code": 0,
   "message": "SUCCESS",
   "data": {},
   "category": "sunlogin",
   "action": "record-wakeup-time"
}

通过mac获取sn

基本信息

Path: /sunlogin/get-snbymac

Method: POST

接口描述:

1、加密规则:

对 mac、_t为键值的数组进行ksort(对关联数组按照键名进行升序排序)后 ,以英文逗号 , 将数组变成字符串,加上密钥后md5

php如:

const SECRET_KEY = '+=kaijihezi-snbymac=+'; // 密钥

ksort($param);

$sign = md5(implode(',',$param ) . self::SECRET_KEY)


2、错误码

1 => '失败'

2 => '验证无效'

5 =>'参数有误'

1209 => '设备不存在'

Request

Headers

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

Query

参数名称是否必须示例备注
mac是FC:83:C6:80:19:3C
_t是1619069826当前提交time()时间 (防超时)
sign是a49e1fd411628117c2710b1581e184a4加密后的密钥(MD5)

Reponse

{
   "code": 0,
   "message": "SUCCESS",
   "data": {
      "model": "WakeupBox",
      "mac": "FF:52:80:4C:CA:EA",
      "sn": "912345678894",
      "code": "3832a4c1f6b32e5e"
   },
   "category": "sunlogin",
   "action": "getsnbymac"
}

快码相关

解除快码与帐号的关联

基本信息

Path: /remote/unbind-fastcode

Method: GET

接口描述:

statusCode: 200

Request

Query

参数名称是否必须示例备注
fastcode是115834217快码
fastcodepsw是授权码的密码licensepsw(由于windows端的配置里用fastcodepsw,因此定义了该名称,实际上它们的值在数据表里都是一样)

Reponse

{
   "code": 0,
   "message": "SUCCESS",
   "data": [],
   "category": "remote",
   "action": "unbindfastcode"
}

产品试用

试用次数更新

基本信息

Path: /tryout/renew

Method: GET

接口描述:


Request

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/x-www-form-urlencoded是
Authorization是Bearer xxx
User-Agent是SLRC/6.4.0.50107 (Android,loginver=10)

Query

参数名称是否必须示例备注
type是类型 camera:摄像头 mobile:移动设备 cmd, ssh, file:远程文件
userid否被控才需要传主控的userid, 更新主控的试用次数
merge_client否true主被控一体客户端,传此参数,试用数变更视作主控

Reponse

{
    "code": 0,
    "message": "SUCCESS",
    "stdcode": 0,
    "data": {
        // 当前服务名称
        "trial_servicename": "行业青春版",
        // 是否含有移动授权
        "mobile_auth": true,
        // 每天次数
        "frequency": 3,
        // 每次分钟
        "duration": 15,
        // 移动设备控制
        "mobile": {
            // 是否开启试用
            "tryout": true,
            // 限制次数
            "limit": 3,
            // 主控已用次数
            "slcc": 0,
            // 被控已用次数
            "slrc": 0
        },
        // 摄像头
        "camera": {
            "tryout": false,
            "limit": 3,
            "slcc": 0,
            "slrc": 0
        },
        // cmd
        "cmd": {
            "tryout": false,
            "limit": 3,
            "slcc": 0,
            "slrc": 0
        },
        // ssh
        "ssh": {
            "tryout": false,
            "limit": 3,
            "slcc": 0,
            "slrc": 0
        },
        // 远程文件
        "file": {
            "tryout": false,
            "limit": 3,
            "slcc": 0,
            "slrc": 0
        }
    },
    "category": "tryout",
    "action": "limit"
}

试用限制

基本信息

Path: /tryout/limit

Method: GET

接口描述:


Request

Headers

参数名称参数值是否必须示例备注
Authorization是Bearer xxx
User-Agent是SLRC/6.4.0.50107 (Android,loginver=10)

Query

参数名称是否必须示例备注
_format否json数据返回类型
userid否123456被控才需要传主控的userid, 获取主控的远控权限

Reponse

{
    "code": 0,
    "message": "SUCCESS",
    "stdcode": 0,
    "data": {
        // 当前服务名称
        "trial_servicename": "行业青春版",
        // 每天次数
        "frequency": 3,
        // 每次分钟
        "duration": 15,
        // 移动设备控制
        "mobile": {
            // 是否开启试用
            "tryout": true,
            // 是否能使用
            "isuse": false,
            // 限制次数
            "limit": 3,
            // 主控已用次数
            "slcc": 0,
            // 被控已用次数
            "slrc": 0,
            // 是否含有移动授权
            "mobile_auth": false
        },
        // 摄像头
        "camera": {
            "tryout": false,
            "isuse": false,
            "limit": 3,
            "slcc": 0,
            "slrc": 0
        },
        // cmd
        "cmd": {
            "tryout": false,
            "isuse": false,
            "limit": 3,
            "slcc": 0,
            "slrc": 0
        },
        // ssh
        "ssh": {
            "tryout": false,
            "isuse": false,
            "limit": 3,
            "slcc": 0,
            "slrc": 0
        },
        // 远程文件
        "file": {
            "tryout": false,
            "isuse": false,
            "limit": 3,
            "slcc": 0,
            "slrc": 0
        }
    },
    "category": "tryout",
    "action": "limit"
}
上一页
asapi
下一页
向日葵管理(sl-api)
Built with