1. 开发前必读

1.1. 开放平台注册

开发者需先注册并登录 轻筑开放平台,完成用户信息审核。个人认证企业认证 按需选择.

1.2. 申请应用

完成用户注册并审核通过后即可创建应用并提交应用申请,应用审核通过后,你可以在应用详情页面获取到此应用的 appIdsecret (请妥善保管)。

1.3. 环境说明

环境 基地址 说明
生产环境 https://open.qingzhuyun.com 第三方应用对接使用

1.4. 接口调用

1.4.1. 获取凭证

在调用开放平台业务接口前,你需要使用 appIdsecret 兑换接口访问凭证(auth-token)。接口说明参考 获取凭证 接口文档。

凭证的有效期为7200秒,在有效期内凭证可以重复使用。请勿频繁刷新凭证,此接口限制了调用频率为5秒钟1次,低于五秒钟的重复调用不能获取到新的token。推荐获取到凭证后进行缓存,然后在3600秒到7200秒之间选取合适的时间替换。

1.4.2. 获取当前登录用户信息

平台在在每次跳转第三方应用时都会附带用户授权码(qzcode)在第三方提供的链接上。

  • 例如:第三方的链接为 https://www.example.com 那么访问时附带如下形式参数 https://www.example.com?qzcode=XXX 。第三方可以从链接获取传入的 qzcode 并使用。
  • qzcode 为临时授权码,即使同一用户在每次访问统一第三方应用时都不相同。qzcode 的有效时间为5分钟,并且为一次性使用,失效后需要重新获取。在获取到qzcode后请尽快使用。

获取到 qzcode 后请查看用户授权接口文档来获取相关信息。

1.4.3. 业务接口调用

凭证只能访问对应appId授权服务包含的接口,未授权的接口将不能访问。请查阅业务接口文档来获取相关的业务数据

接口文档目录按 服务分组 -> 服务 -> 接口 进行划分,方便快速查找对应接口及接口权限

1.4.4. 第三方平台对接说明

一、对接说明

若为第三方数据对接时,请在“”我的应用“”中,创建新应用并将应用名称命名为详细对接类型(在备注中,加入对接的项目名称),“应用类型”选择为“服务应用“,并选择“适用团队”为“项目团队”,项目团队类型为对应类型即可。安全域名按需填写。

在授权服务中,在“团队”项,无需勾选任何信息;在“项目”中,勾选“获取项目信息”与“获取组织机构”,填写完毕后点击提交,进行服务申请,申请完毕后,即可获取appId与secret。

若出现“授权被驳回”的情况,通常是因为填写内容或选择权限存在问题。请根据具体原因进行更改,并重新创建新应用重新申请。

二、实名制数据对接

2.1 对接准备:
  • 测试时,请使用测试项目projectId:854e82a217bc41eaa44351e086624634
  • 正式项目对接时,请联系项目人员或轻筑前端负责人,获取对接项目的projectId。
2.2 对接步骤:组织机构同步 → 实名制数据同步
(1)组织机构同步:

在左侧菜单页面,选择“项目”,在“获取组织机构”中,可通过对应的接口新增、修改、查询当前项目的组织机。组织机构目前支持两级(参建单位-班组),新增项目组织时需先上传参建单位(创建该节点时,无需上传父节点),再上传班组(父节点为之前上传的参建单位节点的UUID)。注意:创建的所有组织机构状态如果没有特殊要求,请选择为默认状态。

(2)实名制数据同步:

实名制相关数据同步应按单个项目进行。如下截图中4个接口可以支持将实名制数据同步给轻筑平台。

© All Rights Reserved            updated 2024-09-19 16:36:53

results matching ""

    No results matching ""