V6.8.4及以后版本

本文档仅适用于V6.8.4及以后版本

1、用户凭证

如果不是通过乐创者内部系统（如乐创者门户、LczApp、乐创者微应用（钉钉、企业微信、浙政钉）等）进行大屏访问的，可通过先获取用户凭证的方式进行大屏的访问。

1.1、获取用户凭证

• 接口规范

  Request Method：POST
  Content-Type：application/json;charset=UTF-8
  Request URL：{http}://{ip}:{port}/{lczServer}/oapi/privilege/getUserAuthId

• 请求参数

请求体格式：

{
  "header": {
    "contentType": "${contentType}",
    "privilege_type": "${privilege_type}",
    "validateVariants": "${validateVariants}",
    "v": "${v}"
  }
}

参数说明

• 返回结果

成功时的返回格式：

{
  "success": true,
  "content": {
    "authId":"",   //用户令牌
    "createTime":0,  //令牌创建时间
    "expiresTime":0, //令牌失效时间
    "refreshToken":""  //用于令牌刷新（只能用一次）
    }
}

出错时返回格式：

{
  "success":false,
  "code":"错误码",
  "msg":"错误信息"
}

1.1.1、认证参数示例

1.1.1.1、明文方式传参

{
  "header": {
    "contentType": "JSON",
    "privilege_type": "LczCloudFormTest",
    "validateVariants": "openId=123;clientId=123;test_Mode=1;access_token=abc;userName=testUser;userAlias=测试用户;orgName=zjsj;orgAlias=浙江税局"
  }
}

1.1.1.2、密文方式传参

{
  "header": {
    "contentType": "JSON",
    "privilege_type": "LczCloudFormTest",
    "v": "dmFsaWRhdGVWYXJpYW50cyUzRG9wZW5JZCUzRDEyMyUzQmNsaWVudElkJTNEMTIzJTNCdGVzdF9Nb2RlJTNEMSUzQmFjY2Vzc190b2tlbiUzRGFiYyUzQnVzZXJOYW1lJTNEdGVzdFVzZXIlM0J1c2VyQWxpYXMlM0QldTZENEIldThCRDUldTc1MjgldTYyMzclM0JvcmdOYW1lJTNEempzaiUzQm9yZ0FsaWFzJTNEJXU2RDU5JXU2QzVGJXU3QTBFJXU1QzQw"
  }
}

加密的原始字符串

validateVariants=openId=123;clientId=123;test_Mode=1;access_token=abc;userName=testUser;userAlias=测试用户;orgName=zjsj;orgAlias=浙江税局

1.2、验证用户凭证

• 接口规范

  Request Method：GET
  Request URL：{http}://{ip}:{port}/{lczServer}/oapi/authId/check/{authId}

• 请求参数

参数说明

• 返回结果

成功时的返回格式：

{
  "success": true,
  "content": {
    "expiresTime":0,  //失效时间
    "timeExpireAfter":0, //多少时间之后过期
    "checkSuccess":false //是否失效
    }
}

出错时返回格式：

{
  "success":false,
  "code":"错误码",
  "msg":"错误信息"
}

1.3、刷新用户凭证

• 接口规范

  Request Method：POST
  Content-Type：application/json;charset=UTF-8
  Request URL：{http}://{ip}:{port}/{lczServer}/oapi/authId/refresh

• 请求参数

请求体格式：

{
  "header": {
    "contentType": "${contentType}",
    "authId": "${authId}"
  },
   "requestBody": {
        "refreshToken":"${refreshToken}"  
  }
}

参数说明

• 返回结果

成功时的返回格式：

{
  "success": true,
  "content": {
    "authId":"",   //用户令牌
    "createTime":0,  //令牌创建时间
    "expiresTime":0, //令牌失效时间
    "refreshToken":""  //用于令牌刷新
    }
}

出错时返回格式：

{
  "success":false,
  "code":"错误码",
  "msg":"错误信息"
}

1.4、更新虚拟用户信息

• 接口规范

  Request Method：POST
  Content-Type：application/json;charset=UTF-8
  Request URL：{http}://{ip}:{port}/{lczServer}/oapi/auth/user/update

• 请求参数

请求体格式：

{
        "header": {
             "contentType": "${contentType}",
            "authId": "${authId}"
        },
        "requestBody": {
        "userAlias": "用户显示名称",
        "jobNumber": "用户工号",
        "orgName": "用户所属组织名称",
        "orgAlias": "用户所属组织显示名称",
        "orgNumber": "组织工号",
        "roleNames": ["用户角色"],
        "roleAlias": ["用户角色显示名称"],
        "dingId": "用户钉钉id",
        "weCorpId": "用户企业微信Id",
    "paramInfos":[
                {
          "name":"参数名称",
            "value":"参数值"
        }
     ]
  }
}

参数说明

• 返回结果

成功时的返回格式：

{
    "success": true
}

出错时返回格式：

{
  "success":false,
  "code":"错误码",
  "msg":"错误信息"
}

#

2 通过发布地址直接访问大屏

2.1 通过匿名身份的方式访问

页面访问规范

Request Method：GET
Request URL：{http}://{ip}:{port}/{lczServer}/lczMatrix/index.html#/publish/{releaseId}

releaseId:发布后的唯一访问key

:::tips
注意

1. 此模式只有在系统开启了允许匿名访问的情况下才支持
2. 此模式下，因为无用户身份，所以不支持不同用户访问时，数据权限范围不一样的需求
   :::

2.2 通过乐创者用户凭证的方式访问

适用于：
1）乐创者内部系统；
2）已经获取乐创者用户凭证的外部系统。

页面访问规范

Request Method：GET
Request URL：{http}://{ip}:{port}/{lczServer}/lczMatrix/index.html?authId={authId}&t={4位时间戳}#/publish/{releaseId}

请求参数

2.3 通过指定认证的方式访问

Request Method：GET
Request URL：{http}://{ip}:{port}/{lczServer}/lczMatrix/index.html?authId=xxxx&t={4位时间戳}&privilege_type=xxxx&validateVariants=xxxxx&v=xxx&其他扩展参数#/publish/{releaseId}

releaseId:发布后的唯一访问key

注意：以下参数值都需求进行URLEncode编码。

2.3.1 明文方式请求参数

注意：
（1）上述参数的值需要URIEncode编码；
（2）这里的参数及值会一直传递到子屏中以及相关数据视图(主要是http查询类型)请求的cookie中。

2.3.2 密文方式请求参数

3 通过大屏内部名称直接访问大屏

页面访问规范

Request Method：GET
Request URL：{http}://{ip}:{port}/{lczServer}/lczMatrix/index.html?t={4位时间戳}&variants=变量值&其他扩展参数&privilege_type=xxxx&validateVariants=xxxxx&v=xxx#/preview/{fileName}/{targetVolume}/{authId}/{fileAlias}

参数说明：

:::tips
注意

1. 大屏变量及值在lczMatrix/index.html后面进行传递
2. 上述参数的值需要URIEncode编码；
3. 这里的参数及值会一直传递到子屏中以及相关数据视图(主要是http查询类型)请求的cookie中。
   :::

   3.1 通过匿名身份的方式访问

:::tips
注意

1. 此模式只有在系统开启了允许匿名访问的情况下才支持
2. 此模式下，因为无用户身份，所以不支持不同用户访问时，数据权限范围不一样的需求
   :::

3.2 通过乐创者用户凭证的方式访问

适用于：
1）乐创者内部系统；
2）已经获取乐创者用户凭证的外部系统。

3.3 通过指定认证的方式访问

:::tips
注意
1、privilege_type为注册的第三方认证类的key

:::

4 访问大屏管理页面

大屏管理页面访问规范

Request Method：GET
Request URL：{http}://{ip}:{port}/{lczServer}/lczMatrix/index.html#/{targetVolume}/{auth}

4.1 通过指定用户凭证的方式访问

请求参数

4.2 通过指定认证的方式访问

请求参数

5 访问大屏设计文件

页面访问规范

Request Method：GET
Request URL：{http}://{ip}:{port}/{lczServer}/lczMatrix/index.html#/design/{fileName}/{targetVolume}/{auth}

5.1 通过指定用户凭证的方式访问

请求参数

5.2 通过指定认证的方式访问

请求参数