Appearance
快速接入
本文将介绍如何用最短的时间完成 H5 电子印章 SDK 的集成。
简介
本节涵盖电子印章申请、授权、管理相关功能,以 H5 形式提供支持
PC 环境:调用 SDK 时 会生成一个二维码提供用户扫码在手机端打开 SDK
移动端:调用 SDK 时,完成初始化后会直接跳转到 SDK 相关功能页面
注意
以下文档内容中"{}"包含的变量信息均可从客户端凭证文件中获取,对接过程中需替换对应的值
SDK 集成
步骤 1:租户开通
签署 SDK 使用需要用到亲笔签运营平台,需申请客户端凭证等相关信息,可由项目侧或者商务侧发起邮件申请,并给租户分配指定权限
步骤 2:获取 Token
通过步骤一得到的客户端凭证等相关信息可以调用能力平台的获取 Token 的接口来获取调用签署 SDK 所需的 token,详细 Token 获取接口调用流程见<服务端 API-获取 Token>接口 ↓
步骤 3:引入 SDK
经过步骤 1、2 准备工作已做好,现在可以在项目中使用电子印章 SDK 了,我们提供了以下常见的 Web/H5 项目对接方式的 demo 代码,您可以选择合适的代码集成
html
<html>
<head> </head>
<body>
<script src="{SDK访问地址}/open-seal-sdk/index.min.js"></script>
<script>
window.aosSealSDK.openSDK({
// 请求参数参考下列表格
params: {
token: "",
type: "",
name: "",
code: "",
legalName: "",
legalIdentity: "",
socialCreditCode: "",
bindApi: "{能力访问地址}/{渠道编码}-{应用编码}/aoscript-gateway",
},
// 如果有该字段,则二维码以<img src="xxx" />插入该容器中,
// 未传值则默认插入Body标签下,并且添加默认UI效果
// 移动端会忽略该字段
// container: "",
// 默认不传值,可修改域名访问的SDK地址
// host: "{SDK地址}",
headers: {
"X-AOS-Voucher": "{客户端凭证}"
}
api: "{能力访问地址}/{渠道编码}-{应用编码}/aoscript-gateway"
});
</script>
</body>
</html>
参数描述
openSDK 参数配置
参数名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
params | Params | 是 | 配置项 |
container | HTMLElement | 否 | PC 端生成的二维码承载容器 |
host | String | 否 | 访问 SDK Host 地址,默认和 JS-SDK 同域名 |
headers | Object | 否 | 自定义请求头 |
api | String | 否 | 接口根地址 |
Params 参数配置
参数名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
token | String | 是 | Token |
type | Number | 是 | 1-企业,2-个人 |
name | String | 否 | 个人为名字,企业为企业名 |
code | String | 否 | 个人为身份证号,企业为社会信用代码 |
legalName | String | 否 | 法人姓名 |
legalIdentity | String | 否 | 法人证件号 |
socialCreditCode | String | 否 | 个人所属企业社会信用代码(个人专用) |
redirect | String | 否 | 重定向地址 |