慧运营
  1. 开放平台须知
慧运营
  • 开放平台须知
    • 开放平台须知
      GET
    • 获取身份凭证
      GET
  • 开放平台接口
    • 巡检
      • 其他任务
        • 其他任务报告
        • 其他任务完成情况查询
        • 区域内其他任务各门店完成情况
        • 协同任务ID查询
        • 协同任务完成情况查询接口
      • 神秘访客
        • 神秘访客报告开放平台查询接口
      • 常规
        • 区域内巡检人的常规巡检完成情况
        • 常规巡检项数据
        • 常规巡检报告查询
        • 常规巡检完成情况查询
      • 自检任务
        • 根据月份获取自检任务列表
        • 自检报告查询
        • 自检项数据
        • 自检任务完成情况查询
        • 区域内各门店自检任务完成情况
        • 自检报告图片查询
      • 专项任务
        • 专项巡检项数据
        • 专项巡检报告查询
      • 视频任务
        • 视频巡检报告查询
        • 视频巡检完成情况查询
        • 视频巡检项数据
      • 飞行巡检
        • 飞行巡检报告开放平台查询接口
      • 整改单
        • 新增整改单开放平台接口
    • 主数据
      • 获取授权信息
        • 根据授权码获取员工信息
      • 运营组织
        • 删除运营组织
        • 门店批量更换组织
        • 新增运营组织
        • 修改运营组织
        • 查询所有运营组织
      • 门店信息
        • 新增门店
        • 修改门店
        • 通过门店编码查询门店信息
        • 通过组织编码查询门店信息
        • 门店闭店
        • 门店停业
        • 门店营业
        • 获取门店证照
        • 门店证照更新
      • 门店员工
        • 新增门店员工
        • 修改门店员工
        • 根据员工code来查询员工
        • 离职
        • 复职
        • 门店员工批量换店
        • 获取人员证照
        • 门店员工转加盟商
        • 员工证照更新
        • 门店员工转公司员工
      • 公司员工
        • 新增公司员工
        • 编辑公司员工
        • 查询单个公司员工
        • 离职
        • 复职
        • 公司员工批量调组织
        • 公司员工转门店员工
      • 加盟商
        • 修改加盟商
        • 查询所有加盟商
        • 新增加盟商
      • 岗位
        • 新增岗位
        • 修改岗位
        • 查询所有岗位
      • 查询所有员工
    • 训练
      • 训练任务
        • 查询品牌下训练任务列表
        • 查询某个训练任务下的学员完成情况
        • 查询某个学员参与的训练任务
      • 学习地图
        • 查询品牌下学习地图列表
        • 查询某个学习地图下的学员完成情况
        • 查询某个学员参与的学习地图
      • 考试相关
        • 获取学员考试情况数据(最高得分)
        • 获取学员考题结果数据
      • 证书相关
        • 查询品牌下的证书列表
        • 查询获得某个证书的学员明细
        • 查询某个学员获得的所有证书
      • 学分
        • 查询某员工学分流水
      • 统计
        • 查询训练看板月度数据
        • 查询员工训练统计列表
      • 废弃接口
        • (废弃)根据训练任务ID获取员工完成明细
        • (废弃)根据培训计划ID获取员工完成明细
        • (废弃)训练任务列表
        • (废弃)根据培训计划ID获取员工完成明细
    • 费用单
      • 费用单列表查询
      • 根据传入的 单号 进行 状态的变更
    • 表单
      • 问卷
        • 问卷ID查询
        • 根据问卷ID查询问卷回收数据
  1. 开放平台须知

开放平台须知

GET
/
开放平台
最后修改时间:2023-07-03 02:38:22

1.概述#

本开放平台提供慧运营系统能力接口,开发者可以借助这些接口,实现企业应用系统与慧运营的集成

2.接入流程#

企业使用慧运营平台API前,需要先申请开通API接入能力,并取得对接参数
key:一般为企业编码
secret:企业开放平台秘钥
route:企业接口首级路径

3.如何请求接口#

仅支持HTTPS,正式环境地址https://zhyyapi.ruipos.com
分为两步:(posman示例)
1)获取身份凭证
通过/sign接口GET方式传入key、secret获得身份凭证Authorization(返回的body内容)
身份凭证有效期为24小时,请缓存复用。新请求生成新的凭证,频繁请求该接口会导致拦截。
image.png
2)调用接口
POST请求方式,在接口加入首级路径route,固定参数version=1,设置请求头Authorization。
一般有两种请求形式application/json、application/x-www-form-urlencoded,请根据文档描述或者演示代码判断。
如果是application/json,不需要参数值时也需要传入空对象,否则接口可能会返回404。
返回接口在http状态码为200的情况下,返回值body为UTF-8编码,JSON格式。
如:
{
    "status": 0, // 状态码。0表示执行成功,否则表示错误码
    "message":"",// 当status=0 时为”“或无此字段。否则表示错误消息
    "data": object // 表示实际的请求结果。当status=0 时必填
)
image.png

4.接口频率#

受限试用原因,会对每个企业控制在30个请求/秒。

请求参数

Query 参数
version
string 
可选
默认值:
1
Header 参数
token
string 
可选
默认值:
eyJhbGciOiJIUzUxMiJ9.eyJ4ZXRVc2VySWQiOiJ1X3Nka182Mzg0NjgzZDAyYmEyX2xlZkFuNWFqZVMiLCJzdWIiOiJjaGF5dXwxMDAwMXwxIiwiZW1wbG95ZWVOYW1lIjoi57O757uf566h55CG5ZGYMSIsImRpbmd0YWxrQ29ycElkIjpudWxsLCJ3ZUNoYXRVc2VySWQiOm51bGwsImNyZWF0ZWQiOjE3NDg0ODQ2MDY3ODMsInJvbGVzIjpbMV0sImVtcGxveWVlSWQiOjEwMDAxLCJlbnQiOiJjaGF5dSIsImlzR3JleSI6ZmFsc2UsImF1dGhvcml0aWVzIjpbeyJhdXRob3JpdHkiOiJCQVNFIn1dLCJ4ZXRTZGtVc2VySWQiOiIiLCJlbXBsb3llZUNvZGUiOiIxMDAwMSIsImlzU3RvcmVFbXBsb3llZSI6MCwiZGluZ1VzZXJJZCI6bnVsbCwicGFzc3dvcmQiOiJmZjllNzk5ZTM1MjZjYmEwNjI3NTJjMjM0ODIxM2MxYyIsIndlQ2hhdENvcnBJZCI6bnVsbCwib3JnYW5pemF0aW9ucyI6WzFdLCJjdXJyZW50Um9sZSI6MSwiY3VycmVudE9yZ2FuaXphdGlvbiI6MSwiZXhwIjoxNzQ4NTcxMDA2fQ.q8rVGN8tirzX1t02F10mXcS5jkKLUzdBCoCSReY-IpWPeIahGoc68opecNPcfo1G0amFNzJ1pSFhFpKgvTVPxQ
ent
string 
可选
默认值:
{{ent}}
Content-Type
string 
可选
默认值:
application/json

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET '/?version=1' \
--header 'token: eyJhbGciOiJIUzUxMiJ9.eyJ4ZXRVc2VySWQiOiJ1X3Nka182Mzg0NjgzZDAyYmEyX2xlZkFuNWFqZVMiLCJzdWIiOiJjaGF5dXwxMDAwMXwxIiwiZW1wbG95ZWVOYW1lIjoi57O757uf566h55CG5ZGYMSIsImRpbmd0YWxrQ29ycElkIjpudWxsLCJ3ZUNoYXRVc2VySWQiOm51bGwsImNyZWF0ZWQiOjE3NDg0ODQ2MDY3ODMsInJvbGVzIjpbMV0sImVtcGxveWVlSWQiOjEwMDAxLCJlbnQiOiJjaGF5dSIsImlzR3JleSI6ZmFsc2UsImF1dGhvcml0aWVzIjpbeyJhdXRob3JpdHkiOiJCQVNFIn1dLCJ4ZXRTZGtVc2VySWQiOiIiLCJlbXBsb3llZUNvZGUiOiIxMDAwMSIsImlzU3RvcmVFbXBsb3llZSI6MCwiZGluZ1VzZXJJZCI6bnVsbCwicGFzc3dvcmQiOiJmZjllNzk5ZTM1MjZjYmEwNjI3NTJjMjM0ODIxM2MxYyIsIndlQ2hhdENvcnBJZCI6bnVsbCwib3JnYW5pemF0aW9ucyI6WzFdLCJjdXJyZW50Um9sZSI6MSwiY3VycmVudE9yZ2FuaXphdGlvbiI6MSwiZXhwIjoxNzQ4NTcxMDA2fQ.q8rVGN8tirzX1t02F10mXcS5jkKLUzdBCoCSReY-IpWPeIahGoc68opecNPcfo1G0amFNzJ1pSFhFpKgvTVPxQ' \
--header 'ent: {{ent}}' \
--header 'Content-Type: application/json'

返回响应

🟢200成功
application/json
Body
object {0}
示例
{}
上一页
开放平台须知
下一页
获取身份凭证
Built with