接口通用参数说明
本文档介绍了如何从 PC 端控制台的数据中获取接口调用的必要参数。
参数含义
第三方平台应用 Id(AppId)
应用的唯一标识,对应通用参数 AppId。不同的业务系统可以采用不同的 AppId,不同 AppId 下的数据是隔离的。在测试和生产环境中,均可通过控制台开发者中心-应用集成来自主生成。
子客企业 OpenId(OrganizationOpenId)
简称 OrgOpenId,对应通用参数 ProxyOrganizationOpenId。是第三方平台自定义,对于子客企业的唯一标识。一个子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的,不可更改,不可重复使用。(比如,可以使用企业名称的 hash 值,或者社会统一信用代码的 hash 值,或者随机 hash 值,需要第三方平台应保存),最大 64 位字符串。
子客企业员工/经办人 OpenId(OperatorOpenId)
简称员工/经办人 OpenId。对应通用 ProxyOperator 中的参数 OpenId。是第三方平台自定义,对子客企业员的唯一标识。一个 OpenId 在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(比如,可以使用经办人企业名+员工身份证的 hash 值,需要第三方平台保存),最大 64 位字符串。
子客应用 Id(ProxyAppId)- 非必需参数
子客企业在当前第三方应用下的唯一标识。在子客企业开通电子签后,会生成唯一的子客应用 Id(ProxyAppId)用于代理调用时的鉴权(回调通知-电子签开通通知里会返回此数据 ProxyAppId)。
参数定义
UserInfo
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
OpenId | String | 是 | 经办人(操作员)Id,参考名称说明 OpenId |
Agent
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
AppId | String | 是 | 腾讯电子签颁发给第三方应用平台的应用 ID,32 位字符串,参考名称说明 AppId |
ProxyAppId | String | 否 | 非必需参数,腾讯电子签颁发给子客企业的应用 ID,参考名称说明 ProxyAppId |
ProxyOperator | UserInfo | 否 | 子客企业经办人(操作员),参考名称说明 ProxyOperator |
ProxyOrganizationOpenId | String | 否 | 子客企业的企业 ID,参考名称说明 ProxyOrganizationOpenId |
所有接口都会用到通用参数,概念请参考名称说明,建议企业的经办人使用超管用户,即回调通知-电子签开通通知中的 ProxyOperatorOpenId