ISV生態應用接口Scope說明

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 權限域主要包含：

該 Scope 是最基礎且常用的權限域，包含了電子簽名業務的核心全鏈路介面。授權此 Scope 後，應用可以對模板、簽署文件（含附件）、參與方以及主幹的信封流程進行管理和流轉操作。

介面名稱	介面描述
獲取簽署人模板控制項詳情	獲取指定簽署人的模板控制項資訊及其對應的屬性配置
獲取模板詳情	獲取特定模板的完整資訊，包含欄位以及文件結構詳情
填寫模板生成文件	根據給定的模板，填充業務數據並自動合成 PDF 格式的文件
查詢模板列表	分頁或按特定篩選條件查詢當前帳號下的可用模板列表
查詢文件合成任務詳情	通過異步任務 ID 查詢由模板生成文件任務的最終執行結果

介面名稱	介面描述
上傳文件	將指定的本機文件或業務流文件上傳至平台，供後續簽署使用
根據關鍵字獲取座標	對已上傳的文件進行文字搜尋，並返回符合關鍵字的座標位置資訊
下載文件	下載特定的已簽署完成文件、原始文件或其他業務附屬文件
新增簽署文件	將前述上傳成功的文件繫結至具體的簽署信封或流程中
刪除簽署文件	從信封流程中移除誤傳或暫不需要進行簽署的文件
新增附件	在信封或簽署流程中添加補充性質的說明附件
刪除附件	從信封或簽署流程中移除指定的附件文檔

接口名稱	接口描述
添加簽署人	在特定的信封流程中新增需要執行簽名動作的簽署參與方
刪除簽署人	在特定的信封流程中移除已被廢棄的簽署方
添加抄送人	添加抄送方角色，僅接收進度通知及查看最終簽署完成的文件
刪除抄送人	移除特定的抄送方角色

接口名稱	接口描述
快速發起信封	若對接平台使用此接口創建信封，並在完成簽署後，系統自動處理結束流程，無需再手動調用“結束信封”
創建信封	用於創建草稿狀態的信封，支持配置簽署主題、簽署人設置等參數
開啟信封	當確認所有的簽署文件及簽署人無誤後，正式向下游發出簽署任務
結束信封	手動結束信封。在信封結束前，所有簽署人必須完成簽署，流程結束後資源不可修改
獲取簽署地址	獲取指定簽署人的專屬短連結或可以直接載入的簽署頁面 URL
查詢信封詳情	獲取該信封的整體資訊、關聯文件、參與人以及當前的流轉狀態
撤銷信封	由發起方主動撤回一個尚未全部完成的簽署信封
催辦信封	當信封未簽署完成時，支持向當前需簽署但未簽的簽署人發送催辦提醒，催辦間隔為30分鐘
獲取預覽簽署頁地址	信封開啟後，可通過該接口獲取預覽簽署頁地址。主要用於在對接平台內，實現非信封參與人查看簽署文件及進度的功能
創建信封發送視圖	通過信封 ID 創建信封發送者視圖。該視圖下發起的簽署流程，發起方信息將以 OAuth 中 Access Token 解析到的用戶信息填充

該 Scope 專門針對企業印章或個人名章進行管理授權。適用於僅需進行企業統一圖章庫維護（圖章的增刪改查），而無需直接干預發起簽署流程的第三方生態系統。

接口名稱	接口描述
查詢圖章列表	使用擁有對應圖章查詢權限的 AppID，獲取圖章資源列表數據
創建圖章	使用擁有權限的 AppID，通過上傳圖片的 Base64 編碼字符串（支持 PNG，尺寸 18mm-100mm）創建圖章
編輯圖章	對已創建的圖章進行名稱以及圖片等資訊的修改
刪除圖章	徹底移除指定且不再存在業務關聯的圖章資源

該 Scope 專用於智能合約法務功能域。允許生態夥伴應用在自身的合約審核、法務評估環節，靈活調用文本及版本的比對能力，快速把控合約修訂前後的差異。

介面名稱	介面描述
獲取合約比對結果頁面	獲取展示對比差異結果的可視化頁面地址
查詢合約比對詳情	透過合約比對業務 ID 獲取合約的比對結果，包含差異數量（增、刪、改數量）以及詳細的比對差異內容（明細定位）