1. 概述
本文档旨在为生态伙伴开发者提供 eSign.AI 应用授权体系中的 Scope(权限域)说明。开发者在进行应用授权接入时,需根据实际业务功能需求申请对应的 Scope。每个 Scope 包含了该权限域下允许调用的 OpenAPI 列表,平台将根据授权的 Scope 严格控制应用对相关资源的操作权限。
基础鉴权接口
生态应用正式调用接口前,需要首先通过授权端点获取调用凭证:
接口名称 | 接口路径 | 接口描述 |
获取 AccessToken | POST /esignglobal/v1/oauth2/accessToken
| 通过 appid 和 appsecret 获取鉴权 access_token,用来以具体用户的身份请求 eSign.AI API,Token 有效时长为 24 小时。 |
目前 eSign.AI 生态开放的 Scope 权限域主要包括:
signature:电子签名核心服务
stamp:图章管理服务
comparisons:合同比对服务
2. Scope 详情与接口清单
2.1 Scope: signature (电子签名服务)
该 Scope 是最基础且常用的权限域,包含了电子签名业务的核心全链路接口。授权此 Scope 后,应用可以对模板、签署文件(含附件)、参与方以及主干的信封流程进行管理和流转操作。
模块一:模板服务
接口名称 | 接口描述 |
获取签署人模板控件详情 | 获取指定签署人的模板控件信息及其对应的属性配置 |
获取模板详情 | 获取特定模板的完整信息,包含字段以及文件结构详情 |
填写模板生成文件 | 根据给定的模板,填充业务数据并自动合成 PDF 格式的文件 |
查询模板列表 | 分页或按特定筛选条件查询当前账号下的可用模板列表 |
查询文件合成任务详情 | 通过异步任务 ID 查询由模板生成文件任务的最终执行结果 |
模块二:文件管理
接口名称 | 接口描述 |
上传文件 | 将指定的本地文件或业务流文件上传至平台,供后续签署使用 |
根据关键字获取坐标 | 对已上传的文档进行文本搜索,并返回匹配关键字的位置坐标信息 |
下载文件 | 下载特定的已签署完成文档、源文件或其他业务附属文件 |
添加签署文件 | 将前面上传成功的文件绑定至具体的签署信封或流程中 |
删除签署文件 | 从信封流程中移除误传或暂不需要进行签署的文件 |
添加附件 | 在信封或签署流程中添加补充性质的说明附件 |
删除附件 | 从信封或签署流程中移除指定的附件文档 |
模块三:参与方管理
接口名称 | 接口描述 |
添加签署人 | 在特定的信封流程中新增需要执行签名动作的签署参与方 |
删除签署人 | 在特定的信封流程中移除已被废弃的签署方 |
添加抄送人 | 添加抄送方角色,仅接收进度通知及查看最终签署完成的文件 |
删除抄送人 | 移除特定的抄送方角色 |
模块四:信封管理
接口名称 | 接口描述 |
快速发起信封 | 若对接平台使用此接口创建信封,并在完成签署后,系统自动处理结束流程,无需再手动调用“结束信封” |
创建信封 | 用于创建草稿状态的信封,支持配置签署主题、签署人设置等参数 |
开启信封 | 当确认所有的签署文件及签署人无误后,正式向下游发出签署任务 |
结束信封 | 手动结束信封。在信封结束前,所有签署人必须完成签署,流程结束后资源不可修改 |
获取签署地址 | 获取指定签署人的专属短链接或可以直接加载的签署页面 URL |
查询信封详情 | 获取该信封的整体信息、关联文件、参与人以及当前的流转状态 |
撤销信封 | 由发起方主动撤回一个尚未全部完成的签署信封 |
催办信封 | 当信封未签署完成时,支持向当前需签署但未签的签署人发送催办提醒,催办间隔为30分钟 |
获取预览签署页地址 | 信封开启后,可通过该接口获取预览签署页地址。主要用于在对接平台内,实现非信封参与人查看签署文件及进度的功能 |
创建信封发送视图 | 通过信封 ID 创建信封发送者视图。该视图下发起的签署流程,发起方信息将以 OAuth 中 Access Token 解析到的用户信息填充 |
2.2 Scope: stamp (图章管理服务)
该 Scope 专门针对企业印章或个人名章进行管理授权。适用于仅需进行企业统一图章库维护(图章的增删改查),而无需直接干预发起签署流程的第三方生态系统。
接口名称 | 接口描述 |
查询图章列表 | 使用拥有对应图章查询权限的 AppID,获取图章资源列表数据 |
创建图章 | 使用拥有权限的 AppID,通过上传图片的 Base64 编码字符串(支持 PNG,尺寸 18mm-100mm)创建图章 |
编辑图章 | 对已创建的图章进行名称以及图片等信息的修改 |
删除图章 | 彻底移除指定且不再存在业务关联的图章资源 |
2.3 Scope: comparisons (合同比对服务)
该 Scope 专用于智能合同法务功能域。允许生态伙伴应用在自身的合同审核、法务评估环节,灵活调用文本及版本的比对能力,快速把控合同修订前后的差异。
接口名称 | 接口描述 |
获取合同比对结果页面 | 获取展示对比差异结果的可视化页面地址 |
查询合同比对详情 | 通过合同比对业务 ID 获取合同的比对结果,包含差异数量(增、删、改数量)以及详细的比对差异内容(明细定位) |