链文档入门指南 Chaindoc 是一个基于区块链的电子签名与文档管理平台。为现代企业提供安全、合规且开发者友好的解决方案。 什么是Chaindoc？ Chaindoc 是一款集文档管理、电子签名与团队协作于一体的综合解决方案。基于区块链技术构建，它提供不可篡改的文档验证、具有法律效力的电子签名以及企业级安全保障。 区块链验证确保文件真实性 具有法律约束力的电子签名及合规性 开发者友好的API和SDK 企业级安全与加密 通过Webhook实现实时通知 主要功能 区块链验证 发布于Chaindoc的每份文件均会在区块链网络（以太坊、Polygon、BSC、Arbitrum）上自动验证。这将生成不可篡改的记录，既能证明文件真实性，又能防止数据被篡改。 电子签名 符合eIDAS、ESIGN法案及UETA的具有法律约束力的电子签名 多种签名类型：简单型、高级型和合格型 多方签署工作流 顺序或并行签字顺序 截止日期管理与自动提醒 文档管理 版本控制附完整审计记录 支持PDF、Office文档、图片及视频格式 细粒度访问控制（私有、公开、团队、受限） 元数据与标签组织 全文搜索功能 开发者工具 具备完整文档的RESTful API 适用于 Node.js 后端和 Web 前端的 TypeScript SDK 内嵌签名界面实现无缝集成 用于实时事件通知的Webhooks 用于测试的沙盒环境 团队协作 基于角色的访问控制（所有者、管理员、成员、查看者） 团队工作区和共享文档 活动日志与审计记录 KYC/身份验证与Sumsub集成 工作原理 上传文档 通过网页界面或API上传文档。支持PDF、Office文件、图片及视频格式。 创建签名请求 添加收件人并配置签名工作流。设置截止日期和自定义消息。 签署人收到通知 收件人将通过电子邮件收到通知，内含安全签名链接或嵌入式界面。 文件签署 签署人通过一次性密码验证身份，审阅文件并应用电子签名。 区块链验证 签署文件将自动在区块链上进行验证，以提供不可篡改的证明。 完成 所有相关方均将收到附有区块链证书的签名文件。 使用场景 法律与合规 经区块链验证真实性的合同、保密协议、雇佣协议及法律文件。 房地产 房产协议、租赁合同及交易文件均采用不可篡改记录。 金融服务 贷款协议、投资文件及合规表格均符合监管要求。 医疗保健 患者知情同意书、医疗记录及符合HIPAA标准的文件管理。 企业 内部审批、人力资源文件、供应商协议及通过API实现的自动化工作流。 建筑 Chaindoc采用多层架构，融合传统云基础设施与区块链技术： Web应用程序 - 基于React的单页应用（SPA），采用Next.js框架 REST API - 带速率限制和身份验证的Node.js后端 数据库 - PostgreSQL用于结构化数据，S3用于文件存储 区块链层 - 以太坊、Polygon、BSC、Arbitrum上的智能合约 消息队列 - 面向Webhook和通知的事件驱动架构 CDN - 全球内容分发网络，实现文档快速访问 安全与合规 端到端加密（AES-256） SOC 2 类型 II 认证基础设施 符合GDPR、eIDAS、ESIGN法案及UETA法规要求 定期安全审计与渗透测试 双因素认证（2FA） API密钥的IP白名单 入门指南 准备开始了吗？选择你的道路： 快速入门 - 5分钟内完成首份文件签署 安装 - 为您的开发环境配置 SDK API 文档 - 深入探索 REST API 参考指南 SDK - 探索适用于网络应用的 Node.js 服务器 SDK 和嵌入式 SDK 从快速入门指南开始，获取实践操作指引 探索 API 文档以获取集成详情 加入我们在GitHub上的开发者社区 企业咨询请联系 [support@chaindoc.io](mailto:support@chaindoc.io)

Introduction

快速入门指南 10分钟快速上手Chaindoc。本指南同时涵盖网页界面操作与开发者API集成。 面向最终用户 Chaindoc账户（免费注册请访问chaindoc.io） 一份可签名的文件（PDF、DOC或图像格式） 签署人的电子邮件地址 分步指南：创建首个签名 注册 请访问[app.chaindoc.io](https://app.chaindoc.io)创建免费账户。请完成邮箱验证。 上传文档 点击"新建文档"并上传文件。支持PDF、Office文档、图片（单个文件不超过50MB）。 添加文档详情 输入文档名称、描述及标签以便分类管理。选择访问权限级别（私有、团队或公开）。 创建签名请求 点击"请求签名"，添加收件人邮箱，设置截止日期，并自定义消息。 配置签名流程 选择签名顺序（并行或顺序），根据需要启用KYC，选择通知偏好设置。 发送请求 审核并发送。收件人将收到含安全签名链接的邮件。 跟踪进度 实时监控签名状态。当收集到签名时接收通知。 下载已签名文件 完成后，下载带有区块链证书的签名文件。 本文件经区块链验证确保真实性 所有相关方均持有签署文件的副本 不可变的审计轨迹已创建 具有法律约束力的合规签名 开发者须知 通过我们的REST API和SDK将Chaindoc集成到你的应用程序中。 1. 获取 API 密钥 访问API需订阅商业版套餐 在控制面板中导航至 设置 → API 访问 为前端创建公钥（pk_），为后端创建私钥（sk_） 2. 安装 SDK 根据使用场景选择SDK： 3. 通过API创建您的首个文档 4. 创建签名请求 5. 集成签名界面（前端） 在您的网络应用中进行嵌入式签名时： 6. 状态追踪与事件处理 7. 设置 Webhook（可选） 接收事件实时通知： 完整工作流示例 以下是一个整合所有步骤的完整端到端示例： 后续步骤 请阅读安装指南以获取详细的SDK配置说明 探索 API 文档以获取完整的端点参考 查阅SDK文档获取框架特有的示例（React、Vue、Angular） 设置Webhooks以获取实时事件通知 审查生产环境部署的安全最佳实践 开发时请使用沙盒环境（pk_test_/sk_test_） 将API密钥存储在环境变量中，切勿写入代码 开发期间启用调试模式以获取详细日志 先用小文件测试以熟悉工作流程 加入我们的GitHub社区获取代码示例和技术支持 常见问题 区块链验证需要多长时间？ 区块链验证通常在1-5分钟内完成，具体取决于网络状况。文件可立即获取，验证过程异步进行。 是否可以在不订阅付费方案的情况下进行测试？ 是的！免费套餐包含网页界面访问权限。API访问需订阅商业套餐，但您可使用沙盒环境进行测试。 签名是否具有法律约束力？ 是的，Chaindoc签名符合eIDAS、ESIGN法案及UETA法规要求。区块链验证可提供额外的法律证据。 支持哪些文件格式？ PDF、DOC、DOCX、XLS、XLSX、PPT、PPTX、TXT、JPG、PNG、GIF、WEBP、SVG、MP4、AVI、MOV、WMV。最大文件大小：50MB。

Quick Start

安装 Chaindoc SDK完整安装指南。配置Server SDK实现后端集成，部署Embed SDK构建前端签名界面。 先决条件 需具备API访问权限的Chaindoc账户（需订阅商业版） Node.js 18+ 用于服务器 SDK 现代浏览器对嵌入式SDK的支持（Chrome、Firefox、Safari、Edge） 控制面板中的API密钥（公钥和私钥） 服务器 SDK 安装 服务器端SDK用于后端集成——文档管理、签名请求及区块链验证。 步骤 1：安装软件包 步骤 2：配置环境变量 在项目根目录创建一个 .env 文件： 切勿将.env文件提交至版本控制系统 将 .env 文件添加至 .gitignore 开发、测试和生产环境需使用不同密钥 为保障安全，请定期更换密钥 步骤3：初始化SDK 步骤4：验证连接 嵌入式SDK安装 嵌入式SDK为网络应用程序提供签名接口。兼容任何JavaScript框架。 步骤 1：安装软件包 步骤 2：配置环境变量 步骤3：在您的应用中初始化 框架特定设置 Next.js（应用路由器） Next.js（Pages Router） Nuxt 3 Angular TypeScript 配置 两个SDK均包含完整的TypeScript定义文件，无需额外安装@types包。 环境配置 开发环境 生产环境 验证 通过以下验证步骤测试您的安装： 检查SDK版本 console.log(ChaindocEmbed.version); // 应输出版本号 验证API连接 测试健康检查端点以确认API密钥有效 测试文件上传 上传小型测试文件以验证媒体接口是否正常工作 初始化嵌入式SDK 初始化SDK并检查浏览器控制台是否有任何错误 故障排除 模块未找到错误 TypeScript 错误 若遇到 TypeScript 错误，请确保 tsconfig.json 中的模块解析设置正确，并已安装 Node.js 类型库。 API密钥问题 401 未授权 - API密钥无效或已过期 403 禁止访问 - 访问API需提供商业计划 密钥必须与环境匹配（测试环境使用测试密钥，生产环境使用正式密钥） 前端使用公钥（pk_），后端仅使用私钥（sk_） 后续步骤 查阅快速入门指南，开始您的首次集成 查阅API文档获取端点参考 探索 SDK 文档以了解高级功能 设置Webhook以获取实时通知 加入GitHub开发者社区获取支持 每个环境请使用独立的API密钥 开发期间启用调试模式以获取详细日志 监控SDK版本并定期更新 在生产环境部署前，请在测试环境中进行全面测试

Installation

电子签名 轻松创建具有法律效力的电子签名。 Chaindoc 提供一种简单安全的方式，为您的文件添加电子签名。我们的签名符合国际标准，并通过区块链验证提供支持，确保最大程度的法律效力与审计追踪完整性。 签名类型 Chaindoc支持多种签名类型，以满足不同的法律和商业需求： 简单电子签名（SES） 适用于低风险文件及内部协议的基础数字签名： 点击签署功能 需进行邮箱验证 适用于保密协议、内部审批及非正式协议 快速签署流程，无需身份验证延迟 基本审计记录，包含时间戳和IP地址 高级电子签名（AES）（将于2026年推出） 针对业务关键文档的增强安全性： 多因素认证（短信、认证应用或电子邮件） 签署前需进行身份验证 适用于合同、雇佣协议及供应商协议 包含签名者身份验证信息的完整审计追踪记录 区块链认证结业证书 合格电子签名（QES）（将于2026年推出） 最高级别的签名，具有与手写签名同等的法律效力： 经可信证书颁发机构认证 通过政府签发的文件进行身份验证 符合《欧洲数字身份、认证与电子交易服务条例》(eIDAS)、《电子签名法案》(ESIGN Act)及《统一电子交易法案》(UETA) 适用于高度监管行业（法律、金融、医疗） 硬件安全模块（HSM）保护的证书 不可变区块链签名证明 法律合规 Chaindoc签名符合全球主要电子签名法规： 国际标准 eIDAS（电子身份与信任服务）- 欧盟 《全球与国内商业电子签名法案》（ESIGN Act）——美国 《统一电子交易法》(UETA) - 美国 PIPEDA（《个人信息保护与电子文件法》）- 加拿大 《电子交易法》——澳大利亚 《信息技术法》——印度 合规要求 为确保法律效力，Chaindoc 实施以下措施： 明确签署意图（需获得明确同意） 同意以电子方式开展业务 签名与记录的关联 记录保留与防篡改存储 签署人身份验证 包含时间戳和IP地址的审计记录 区块链支持的完整性证明 签名工作流 创建签名请求 请按以下步骤申请签名： 上传您的文档（PDF、Word或图片格式） 添加签署人及其电子邮件地址和姓名 指定签名顺序（顺序签名或并行签名） 在文档中放置签名字段 配置签名类型和认证要求 添加自定义消息和截止日期（可选） 发送签名请求 签名字段类型 使用多种字段类型定制文档： 签名 - 电子签名字段 首字母缩写 - 用于在页面或条款上签字 签署日期 - 自动填入签署日期 文本字段 - 用于姓名、头衔或自定义信息 复选框 - 用于同意或确认 下拉菜单 - 用于从预定义选项中选择 单选按钮 - 用于排他性选择 签名顺序选项 顺序 - 签署者按指定顺序接收文件 并行 - 所有签署人同时接收文件 混合型 - 结合顺序签名组与并行签名组 条件性 - 下一个签署者取决于前一位签署者的操作 签署者体验 接收签名请求 被邀请签署时，收件人： 通过安全链接接收邮件通知 点击链接访问文档（基础签名无需登录） 如需身份验证（多因素认证、短信验证码等） 审阅文档时需标注签名字段 添加签名、首字母缩写，并填写必填字段 核实信息并确认签名 通过电子邮件即时接收签名副本 签名创建选项 签名者可使用以下方式创建签名： 带有多种字体样式的打字签名 使用鼠标或触摸屏绘制签名 上传手写签名图片 移动设备签名（可用手指或触控笔完成） 已保存签名（供返回用户使用） 区块链验证 每个签名均通过区块链技术进行安全加固： 不可变证明 文件哈希值在签名时记录于区块链 每个签名事件的唯一交易ID 防篡改验证证书 所有相关方均可获取独立验证 永久记录，不受组织变更影响 验证流程 任何人都可验证签名文件： 访问验证门户：verify.chaindoc.com 上传签名文件或输入验证码 系统计算文档哈希值 哈希值与区块链记录进行比对 验证结果显示：文档完整性、签名日期、签名者详情 下载验证证书（可选） 审计记录与证书 全面审计追踪 每个签名均包含详细的审计信息： 文档发送时间戳及发送者信息 每位收件人的邮件投递及打开时间戳 记录文档查看时间戳（签署人访问文档的时间） 认证方法及成功/失败日志 签名时间戳需精确到毫秒 IP地址和设备信息 地理位置数据（若已启用） 文档完成时间戳 区块链交易ID与区块编号 结业证书 自动生成的证书包含： 文档标题与唯一文档ID 所有具有角色的方（发送方、签署方、查看方） 所有事件的完整时间线 签名图片与输入的姓名 已实施的安全措施（认证方法） 区块链验证信息 法律免责声明及服务条款参考 即时验证二维码 高级功能 现场签名 使用单一设备现场收集签名： 用于收集多个签名的托管模式 每位签署者需在同一设备上完成签名 每位签署者均需单独进行电子邮件验证 适用于活动、会议或办公室签到 所有签名均通过独立审计轨迹记录 批量发送 将同一文档发送给多个收件人： 上传包含收件人信息的CSV文件 合并字段以实现个性化（姓名、公司等） 同时发送给数百名签名者 为每份文档设置独立追踪 批量状态报告与提醒 提醒与通知 每3天自动提醒（可配置） 自定义提醒消息 截止日期前的过期警告 文档事件的实时通知 电子邮件和应用内通知选项 签名无效与作废 处理签名拒绝及文件撤销： 签署方可提出合理理由拒绝签署 发件人将立即收到通知 发件人可在文件完成前予以作废 在审计日志中标记为作废的无效文件 所有相关方均已收到拒绝或无效操作的通知 最佳实践 文档准备 使用清晰的文档标题以便于识别 优化PDF文件（压缩大文件，移除安全设置） 将签名字段放置在合理位置 清晰标注字段（例如"客户签名"、"经理审批"） 为复杂字段添加说明或描述 在向重要收件人发送前测试签名流程 安全建议 法律文件请使用高级或合格签名 为敏感协议启用多因素认证 设置适当的过期日期（通常为7-30天） 对高价值合同要求身份验证 将已签署的文件存放在安全存储中 定期备份已签名文件和证书 核验关键文件的区块链记录 沟通技巧 在签名请求中包含清晰的主题行 添加说明文档用途的个性化信息 提供上下文信息及截止日期 包含问题咨询的联系方式 所有沟通均需采用专业语气 紧急文件请电话跟进 故障排除 常见问题 常见签名问题的解决方案： **签名者未收到邮件**：检查垃圾邮件/垃圾文件夹，核实邮箱地址，重新发送请求 **链接已过期**：发件人可延长截止时间并重新发送 **身份验证失败**：请确认联系信息与请求匹配，尝试其他验证方式 **移动端无法绘制签名**：请确保设备支持触控输入，尝试使用键盘输入签名 **文档无法加载**：检查网络连接，尝试其他浏览器，清除缓存 **签名字段缺失**：请联系发件人补充必填字段 支持资源 电子邮件支持：[support@chaindoc.io](mailto:support@chaindoc.io) 面向开发者的API文档

Electronic Signatures

文档管理 高效组织和管理您的文档。 将所有文档集中存放于安全空间。通过精细化权限管理、区块链验证存储及完整审计追踪功能，实现文档上传、整理与团队共享。 文档生命周期 Chaindoc管理文档的整个生命周期，从创建到归档： 文档状态 草稿 - 文档正在准备中，尚未发送 待处理 - 已发送签名请求，等待完成 进行中 - 已部分签署，尚余若干签名 已完成 - 所有签名已收集完毕，文件最终定稿 已拒绝 - 签署人拒绝了该文件 作废 - 发送方在完成前取消 已过期 - 截止日期已过，任务未完成 已归档 - 已完成文档移至长期存储 自动状态转换 文档会根据操作自动在状态间转换： 草稿 → 待处理（发送给签署人时） 待处理 → 进行中（首次签收） 进行中 → 已完成（所有签名已收集完毕） 任何 → 失效（发件人取消） 任何 → 拒绝（签署方拒绝） 待处理/进行中 → 已过期（截止日期已到） 文档组织 文件夹结构 使用灵活的文件夹层级组织文档： 创建无限数量的文件夹及子文件夹 按部门、项目、客户或自定义标准进行分类 通过拖放操作在文件夹间移动文档 团队协作共享文件夹 个人用户专属文件夹 可复用文档的模板文件夹 已完成文档归档文件夹 智能筛选器与视图 通过强大的筛选功能快速查找文档： 按状态筛选（待处理、已完成、已过期） 按日期范围筛选（创建时间、修改时间、签署时间） 按签署人或发送者筛选 按文档类型或模板筛选 按标签和自定义元数据筛选 将自定义筛选组合保存为视图 快速访问最近查看的文档 搜索功能 跨所有文档的高级搜索： 在文档内容内进行全文搜索 按文档标题、描述或元数据搜索 按签署人姓名或电子邮件搜索 通过自定义字段和标签进行搜索 区块链交易ID查询 用于复杂查询的布尔运算符 带高亮和预览的搜索结果 文档上传与导入 支持的文件格式 PDF (.pdf) - 推荐格式 Microsoft Word (.doc, .docx) Microsoft Excel (.xls, .xlsx) Microsoft PowerPoint (.ppt, .pptx) 图片（.jpg, .png, .gif, .tiff） 文本文件（.txt, .rtf） OpenDocument格式（.odt、.ods、.odp） 上传方法 将文件拖拽至浏览器 从计算机中选择文件 从云存储导入（Google Drive、Dropbox、OneDrive） 移动相机拍摄，随时随地扫描 API上传用于程序化集成 批量上传多个文档 邮件附件转链文档工具 自动转换 为保持一致性，文档将自动转换为PDF格式： 将Word、Excel、PowerPoint文件转换为PDF格式 通过OCR（文字识别）技术将图像转换为PDF格式 保留格式、字体和版式 原始文件可供下载 转换在上传时即时完成 文档存储与安全 安全存储 静态数据采用AES-256加密 传输中的TLS 1.3加密 地理分布式存储（多区域） 每6小时自动备份 99.99% 正常运行时间服务等级协议 符合GDPR、HIPAA及SOC 2标准的存储方案 数据驻留选项（欧盟、美国、亚洲） 区块链锚定 所有文件均锚定于区块链以实现防篡改验证： 文档哈希值在上传时记录于区块链 状态变更处添加额外哈希标记 不可篡改的文件存在性与完整性证明 所有相关方均可获取独立验证 即使Chaindoc服务终止仍可存续 版本控制 通过自动版本控制追踪文档变更： 上传相同文档时自动创建版本 查看带时间戳的版本历史记录 版本并排比较 如有需要，请恢复先前版本 每个版本均拥有唯一的区块链哈希值 审计记录显示每个版本的上传者 访问控制与权限 权限级别 文档和文件夹的精细化权限设置： 所有者 - 拥有完全控制权，可删除项目并管理权限 编辑者 - 可编辑、发送签名请求及管理文档 查看者 - 仅限读取权限，可查看和下载 签署人 - 可查看并签署分配的文件 评论者 - 可查看并添加评论（不可编辑） 无访问权限 - 被明确阻止查看 共享选项 通过电子邮件与特定用户共享 与整个团队或部门共享 与外部方（客户、供应商）共享 限时访问（设定时限后失效） 密码保护的共享链接 仅限查看的公共共享链接 临时访问的过期链接 访问审计日志 文档访问的完全可见性： 谁在何时访问了该文档 采取了哪些操作（查看、下载、编辑） IP地址和设备信息 地理位置数据（若已启用） 权限变更历史记录 访问尝试失败 导出审计日志以满足合规要求 文档元数据与标签 标准元数据 自动捕获的元数据： 文档标题与描述 创建日期与创建者 修改日期与最后修改者 文件大小与页数 文档状态与状态 签署方与收件方 完成日期（如适用） 区块链交易ID 自定义元数据 根据业务需求添加自定义字段： 创建自定义字段类型（文本、数字、日期、下拉菜单） 必填或可选字段 部门、项目或客户标识符 合同金额、到期日期 自定义类别与分类 与外部系统（CRM、ERP）的集成 批量编辑多个文档的元数据 标签与标记 在文档中添加无限数量的标签 采用颜色编码标签实现视觉化组织 从现有标签中自动补全 按标签筛选和搜索 批量为多个文档添加标签 根据文档内容提供标签建议 团队级标签库 文件保留与归档 保留政策 通过保留规则实现文档生命周期的自动化管理： 按文件类型设定保留期限（例如税务文件保留7年） 在保留期结束后自动归档 法律保留令以防止诉讼期间删除 遵守行业法规（GDPR、HIPAA、SOX） 归档期后自动删除（可选） 常见场景的保留政策模板 覆盖特定文档的策略 归档存储 已完成文档的长期存储 降低访问频率（冷存储） 成本低于活动存储 需要时即时检索 维护区块链验证 导出归档文件用于外部备份 归档文件的合规性报告 文档导出与下载 导出选项 下载单个文档为PDF格式 批量下载为ZIP压缩包 导出时包含审计记录和证书 将元数据导出为CSV或JSON格式 导出至云存储（Google Drive、Dropbox） 计划导出用于备份 API导出用于系统集成 下载控制 控制文档下载权限： 禁用敏感文档的下载功能 在下载文件中添加用户信息水印 在审计日志中追踪所有下载事件 限制每位用户的下载次数 下载链接使用后失效 下载需额外身份验证 文档分析 使用统计 追踪文档和系统使用情况： 按状态统计的文档总数 平均完成时间 最活跃的用户和团队 记录随时间变化的体量趋势 常用文档类型与模板 存储使用情况与增长趋势 API使用统计 合规报告 待签文件 过期或被拒绝的文件 访问审计报告 用户活动报告 保留政策合规性 区块链验证报告 自定义报告生成器 集成与自动化 云存储集成 与Google Drive双向同步 Dropbox集成用于文件访问 OneDrive 和 SharePoint 连接 Box企业级存储 签名后自动上传至云端 系统间的文件夹映射 业务系统集成 Salesforce - 附加到商机和客户账户 HubSpot - 交易与联系人关联功能 Microsoft Dynamics - CRM 集成 SAP - ERP文档管理 NetSuite - 财务文档工作流 Zapier - 连接5000+应用 自定义API集成 最佳实践 文档组织 批量上传前请建立清晰的文件夹结构 使用一致的命名规范 立即添加标签和元数据 为重复出现的文档类型创建模板 定期归档旧文档 尽早设置保留策略 每季度审查并清理文件夹 安全与合规 每月审核访问权限 立即撤销离职员工的访问权限 对外部人员启用限时共享功能 为敏感文档启用下载水印功能 监控审计日志以发现异常活动 定期备份重要文件 对重要文件的区块链哈希值进行验证 性能优化 上传前请压缩大文件 对多个文档使用批量操作 归档已完成文档以减少杂乱 使用已保存的筛选器，避免重复搜索 在非高峰时段安排导出任务 清理草稿和已取消的文件 故障排除 常见问题 **上传失败**：检查文件大小（上限100MB），确认网络连接，尝试使用其他浏览器 **无法找到文档**：请使用搜索功能替代浏览，检查筛选条件及文件夹访问权限 **权限被拒绝**：请联系文档所有者或管理员获取访问权限 **运行缓慢**：清除浏览器缓存，减少当前显示的文档数量，归档旧文件 **下载功能失效**：请检查弹窗拦截器，确认下载权限，尝试使用其他浏览器 **版本冲突**：多人同时编辑——请与团队协调

Document Management

团队管理 与团队高效协作。 邀请团队成员、分配角色并管理权限，确保组织内部顺畅协作。Chaindoc的团队管理功能在保障安全协作的同时，维持合规性并保留审计记录。 团队架构 组织层级 在Chaindoc中构建您的组织结构： 组织 - 公司的顶级实体 部门 - 按职能划分团队（法律、人力资源、销售等） 团队 - 部门内的较小团体 项目 - 特定计划的临时小组 嵌套结构 - 部门可包含子部门 多组织支持 - 通过单一账户管理多个实体 团队类型 私人团队 - 仅对成员可见 公开团队 - 整个组织可见 跨职能团队 - 来自多个部门的成员 客户团队 - 包含外部协作者 临时团队 - 项目完成后自动归档 用户角色与权限 全局角色 具有不同权限级别的全组织角色： **所有者** - 拥有完整管理权限、账单管理及用户管理权限 **管理员** - 用户管理、团队创建及系统设置 **经理** - 负责所辖区域内的团队与文档管理 **成员** - 具备文档创建和签署权限的标准用户 **访客** - 外部协作者的有限访问权限 **审计员** - 仅限读取权限，可查看审计记录 权限矩阵 各角色可执行的操作： 所有者：拥有包括账户删除在内的所有权限 管理员：管理用户、团队、计费、集成、安全设置 经理：创建团队、管理团队成员、审批文档 成员：创建/发送文档，签署，查看团队文档 访客：仅可查看并签署已分配的文件 审计员：查看所有文档和审计记录，生成报告 自定义角色 根据特定需求创建自定义角色： 定义精细化权限（查看、创建、编辑、删除、审批） 分配给特定部门或团队 文档类型特定权限（例如：仅人力资源部门可访问员工合同） 临时角色分配（含有效期） 常见场景角色模板 受限访问的合规角色 用户管理 添加用户 添加团队成员的多种方式： 含自定义欢迎信息的电子邮件邀请函 通过CSV文件批量导入 单点登录（SSO）自动配置 基于域名的自动加入（拥有@company.com邮箱的用户） 基于API的用户创建 自助注册需经管理员批准 用户资料 每位用户均拥有完整的个人资料： 姓名、电子邮箱及联系方式 个人资料照片和简介 职位名称与部门 团队成员资格 分配的角色与权限 文档活动统计 最后登录时间与活动状态 双因素认证状态 用户生命周期管理 入职流程 - 自动化的欢迎邮件和培训材料 活跃 - 对分配资源拥有完全访问权限 暂停 - 临时访问权限撤销（休假、调查期间） 停用 - 永久访问权限撤销（离职员工） 转移所有权 - 将文档重新分配给其他用户 归档用户数据 - 离职后保留审计记录 团队协作 共享工作区 在团队空间内协作处理文档： 团队文件夹自动为成员开放访问权限 共享文档模板 团队通用标签与元数据 协作编辑与评论 团队活动仪表盘 共享签名工作流 团队分析与报告 通信功能 保留文档注释和提及内容（@用户名） 内部备注（签署方不可见） 团队公告与通知 团队操作动态信息流 文档事件的电子邮件通知 紧急事项请通过应用内消息联系 与 Slack、Microsoft Teams 的集成 审批流程 通过审批链处理文档： 定义多步骤审批流程 顺序或并行审批 基于文档值的条件路由 若未在时限内获批，则自动升级处理 授权审批权限 审批历史与审计追踪 基于模板的常见场景工作流 外部协作 访客访问 安全地与外部方协作： 邀请客户、供应商或合作伙伴作为访客 对特定文档或文件夹的访问权限受限 不得访问内部团队文档 限时访客账户 访客活动记录于审计日志中 无需额外用户许可 如有需要，可轻松转换为正式会员 客户门户 创建品牌门户以支持外部协作： 为客户定制的品牌化界面 客户文档专用空间 客户可上传和下载文件 与客户团队进行安全通信 客户专属报告与分析 白标选项（移除Chaindoc品牌标识） 为不同客户设置多个门户 访问控制与安全 团队级权限 控制团队文档的查看权限 限制特定角色创建文档 敏感文件审批要求 禁止下载或打印 团队访问的IP地址限制 设备限制（仅限企业设备） 地域限制（屏蔽特定国家） 认证选项 通过多种认证方式保障团队访问安全： 邮箱/密码需遵循强密码策略 需启用多因素认证（MFA） 通过SAML 2.0实现单点登录（SSO） Google Workspace / Microsoft 365 集成 LDAP/Active Directory 集成 移动设备上的生物识别认证 硬件安全密钥（FIDO2） 会话管理 闲置后自动注销 强制在密码变更时注销 跨设备查看活跃会话 远程会话终止 按角色划分的会话超时策略 并行会议限制 可疑活动登录警报 团队分析与报告 团队绩效指标 追踪团队生产力并记录活动： 按团队/用户创建的文档 平均签名完成时间 最活跃的用户和团队 文档审批瓶颈 用户登录频率 团队存储使用情况 对签名请求的响应时间 活动报告 用户活动日志（登录、文档访问） 团队协作统计数据 文档状态报告（待处理、已完成） 身份验证失败尝试 权限变更审核 外部用户访问日志 通过电子邮件安排定期报告 合规报告 向监管机构提供访问审计记录 用户认证报告 文件保留合规性 安全事件报告 角色分配历史 数据驻留验证 导出报告以供外部审计 计费与许可 用户许可协议 灵活的许可选项： 按用户许可（按月或按年） 无限量访客用户，无需额外付费 随时可添加或移除用户 自动账单调整 团队大额订单可享批量折扣 企业无限用户计划 新用户免费试用期 使用情况追踪 活跃用户与非活跃用户监测 用户文档卷 团队存储使用情况 API调用用法 功能使用统计 根据使用场景优化许可协议 临近限制的警报 集成与自动化 目录集成 Azure Active Directory 同步 Google Workspace 目录同步 Okta 身份提供商 OneLogin 单点登录集成 LDAP目录导入 自动用户配置/撤销配置 目录中的组映射 团队工作流自动化 自动将文档分配给团队成员 基于角色的自动文件夹访问权限 定期向团队负责人提交报告 待处理文档的自动升级 基于文档事件的工作流触发器 与项目管理工具的集成 团队事件的自定义 webhook 最佳实践 团队设置 以清晰的组织结构开篇 在添加用户前需先定义角色与权限 创建团队命名规范 建立审批工作流模板 在邀请用户前请先配置单点登录（SSO） 记录团队架构与政策 在向整个团队推广前，先对团队负责人进行培训 安全最佳实践 为所有用户强制实施多因素认证 定期访问审查（每季度一次） 立即停用已离职用户 遵循最小权限原则 密切监控访客用户访问权限 定期安全意识培训 测试灾难恢复程序 协作效率 使用模板处理常见团队文档 建立清晰的审批流程 为文档审核设置服务等级协议（SLA） 使用@提及功能通知特定用户 为进行中的项目创建共享文件夹 定期清理不活跃团队 利用分析工具识别瓶颈 新团队成员入职流程 发送包含入门指南的欢迎邮件 为第一周安排导师或伙伴 提供文档工作流培训 逐步授予访问权限（初期限制访问） 安排在第一周后进行进度检查 分享团队指南和最佳实践 添加至相关团队和频道 故障排除 常见问题 **用户无法访问团队文档**：请检查团队成员资格和角色权限 **未收到邀请函**：请检查垃圾邮件文件夹，核实邮箱地址，重新发送邀请函 **单点登录失败**：请验证单点登录配置，联系IT管理员确认 **权限拒绝错误**：用户可能需要更高权限或特定文档权限 **无法添加更多用户**：请检查许可证限制，必要时升级方案 **用户重复出现**：通过管理面板合并重复账户 获取帮助 管理员仪表盘帮助中心 为管理员提供全天候在线聊天支持 专属客户经理（企业版方案） 团队管理视频教程 最佳实践社区论坛 电子邮箱：admin-support@chaindoc.com 事件应急安全热线

Team Management

API集成 通过强大的REST API和SDK将Chaindoc集成至您的应用程序。自动化文档工作流、收集签名并实时同步事件。 概述 Chaindoc提供全面的REST API，支持构建自定义文档签名工作流、自动化流程以及与现有系统集成。该API专为开发者设计，提供完整的TypeScript支持和自动重试功能。 基于区块链验证的文档上传与管理 签名请求创建与追踪 实时网络钩子用于事件通知 内嵌签名界面，实现无缝用户体验 KYC/身份验证集成 团队与角色管理 入门指南 1. 获取 API 访问权限 API访问仅限于商业版计划 在控制台中导航至 设置 → API 访问 生成公钥（pk_）和私钥（sk_） 安全存储密钥，切勿提交至版本控制系统 2. 选择集成方式 Chaindoc提供三种集成方案： REST API - 直接HTTP请求实现最大灵活性 服务器 SDK - 类型安全的 Node.js SDK，支持自动重试 (@chaindoc_io/server-sdk) 嵌入式SDK - 面向网页应用的前端签名接口 (@chaindoc_io/embed-sdk) 3. 快速示例 核心API概念 认证 所有API请求均需在Authorization头中使用API密钥进行身份验证： 公钥（pk_） - 前端应用程序的只读访问权限 密钥 (sk_) - 后端服务器完整读写权限 测试密钥（pk_test_, sk_test_）- 用于预发布/开发环境 实时密钥（pk_live_, sk_live_）- 用于生产环境 速率限制 API 端点设有速率限制以确保公平使用： 通用接口：每10秒限3次请求 媒体上传：每10秒3次请求 读取操作：每60秒10次请求 签名创建：每3秒限20次请求 错误处理 API返回标准HTTP状态码及详细错误信息： 常见集成模式 文档上传与签署流程 上传文件 POST /media/upload - 上传PDF、Office文档或图片 创建文档 POST /documents - 创建状态为'published'的文档记录，用于区块链验证 创建签名请求 POST /signatures/requests - 添加收件人并配置工作流 创建嵌入式会话 POST /embedded/sessions - 为每位签署人生成会话 开放签名接口 使用嵌入式SDK并传入sessionId，在前端打开签名流程 跟踪进度 GET /signatures/requests/:id/status - 监控签名进度 接收 Webhook 当所有签名收集完毕时触发 signature.request.completed 事件 仅限后端的工作流 针对签字方未使用您界面的场景： 批量文档处理 高级功能 Webhooks 接收文档事件的实时通知： KYC 集成 在高安全性工作流中集成身份验证： 访问控制 通过精细化访问控制管理文档权限： 最佳实践 将API密钥存储在环境变量中，切勿写入代码 开发环境使用测试密钥，生产环境使用正式密钥 采用指数退避算法处理速率限制 验证Webhook签名以防止重放攻击 在适当情况下缓存API响应 为提升性能，请在创建文档前上传文件 对于大型数据集请使用分页功能 监控速率限制标头并调整请求频率 示例集成 电子商务平台 自动生成并签署高价值订单的采购协议。 人力资源系统 与人力资源信息系统集成，实现入职期间雇佣合同的自动化签署。 CRM集成 直接从Salesforce、HubSpot或自定义CRM的客户记录中创建签名请求。 文档管理系统 为现有文档管理系统添加区块链验证功能，实现防篡改的审计追踪。 资源 API文档 - 包含所有端点的完整REST API参考 SDK - 服务器端SDK与嵌入式SDK文档及框架示例 Webhooks - 实时事件通知设置指南 快速入门 - 10分钟内完成首次集成部署 GitHub示例 - 集成示例与代码片段 查阅API文档获取详细端点参考 查阅SDK文档以实现类型安全的集成 加入 GitHub 社区获取代码示例 如需企业级支持，请联系 [support@chaindoc.io](mailto:support@chaindoc.io)

API Integration

您的首个签名 使用Chaindoc发送首份待签文件的完整指南。只需5分钟即可掌握签名工作流程。 如何上传和准备文件 添加收件人和签名字段 配置签名工作流选项 追踪签名进度 下载带有区块链证书的签名文件 开始之前 请确保您拥有： Chaindoc账户（免费注册请访问chaindoc.io） 待签署文件（PDF、Word或图片格式） 需要签署人员的电子邮箱地址 对数字签名有基本理解 分步指南 步骤1：上传您的文档 导航至文档 点击侧边栏或仪表盘中的“文档”菜单 点击“新建文档” 在右上角找到“新建文档”或“上传”按钮 选择文件 选择您的文档（推荐PDF格式，最大50MB） 添加详细信息 输入文档名称、描述及标签以便轻松管理 使用描述性名称，例如'雇佣合同 - 约翰·多伊 - 2024' 添加#合同、#2024等标签以提升可检索性 若文档包含敏感信息，请选择"私有"访问权限 步骤二：配置文档设置 在请求签名之前，请配置您的文档： 文档名称 - 清晰、描述性标题 描述 - 需签署事项的简要说明 访问级别 - 仅限您本人、团队共享或公开可见 标签 - 添加如#合同、#紧急等标签以便分类管理 元数据 - 添加自定义字段，如客户名称、合同金额等。 步骤3：创建签名请求 文档上传完成后，请创建签名请求： 点击“请求签名” 在文档详情页上找到按钮 添加收件人 请输入签署人的电子邮箱地址（每行一个或以逗号分隔） 设置签名顺序 选择'并行'（所有签名同时完成）或'顺序'（依次完成） 设定截止日期 选择必须完成签名的截止时间 添加消息 为签署者撰写个性化说明，阐明其签署内容 并行 - 所有收件人可同时签署（更快捷） 顺序式 - 收件人按特定顺序签名（适用于审批流程） 混合模式 - 针对复杂工作流，同时采用两种方法 步骤4：配置高级选项 自定义签名体验： KYC验证 - 高安全级文件需进行身份验证 提醒事项 - 截止日期前的自动邮件提醒 签署后访问 - 允许签署人完成签署后下载文件 通知 - 签名事件的电子邮件/短信通知 过期 - 截止日期后自动过期请求 步骤5：审核并发送 发送前请核对所有细节： 收件人将收到包含安全签名链接的邮件 他们审核文件并应用电子签名 每当有人签署时，您都会收到通知 文档完成后即通过区块链验证 所有相关方均获赠附真品证书的副本 步骤6：跟踪进度 实时监控您的签名请求： 状态仪表盘 - 查看已签署人员与待处理人员 活动时间线 - 查看所有带时间戳的事件 邮件通知 - 获取每条签名的通知 提醒事项 - 系统向待签人员发送自动提醒 取消/修改 - 取消请求或重新发送给特定收件人 步骤7：下载签名文件 所有签名收集完毕后： 完成通知 当所有签名完成时，您将收到电子邮件通知 下载文档 点击"下载"获取包含所有签名的PDF文件 区块链证书 下载区块链验证证书作为真实性证明 审计追踪 导出完整签名历史记录，包含时间戳和IP地址 您已完成首个签名工作流！ 本文件具有法律约束力且经区块链验证 所有相关方均持有附证书的副本 完整的审计记录将永久保存 收件人可见内容 当收件人收到您的签名请求时： 邮件通知 他们收到带有"审阅并签署"按钮的邮件 身份验证 为保障安全，一次性密码（OTP）已发送至其邮箱 文档审查 完整文档预览，支持缩放与导航功能 签署文件 通过绘制、输入或上传图片添加签名 确认 收到包含签署文件副本的确认邮件 常见问题 如果签署人未收到邮件怎么办？ 请先检查垃圾邮件文件夹。若未找到，可从签名请求状态页面重新发送邀请。点击收件人姓名旁的"重新发送"按钮。 我可以取消签名请求吗？ 是的！请导航至签名请求页面，点击"取消请求"。这将通知所有待签名者该请求已被取消。 截止日期之后会发生什么？ 该请求将自动过期且无法继续收集签名。您将收到通知，如有需要可创建带有新截止日期的请求。 这些签名是否具有法律约束力？ 是的！Chaindoc签名符合欧盟《电子识别、认证与信任服务条例》(eIDAS)、美国《电子签名法案》(ESIGN Act)及《统一电子交易法》(UETA)法规。区块链验证为文件真实性提供额外法律依据。 签署者能否在签署前下载文件？ 默认情况下，签署人仅能在线查看文档。如有需要，您可在高级设置中启用"签署前下载"功能。 后续步骤 组建团队 - 邀请同事共同协作文档 创建工作流 - 自动化重复性签名流程 探索模板 - 通过可重复使用的文档模板节省时间 API集成 - 将Chaindoc集成到您的应用程序中 安全最佳实践 - 了解合规与数据保护 使用清晰、具体的文档名称 在消息中为签署人添加背景说明 设定合理的截止日期（至少7天） 请先自行测试工作流程 若签名者未收到邮件，请检查垃圾邮件文件夹 审批流程中采用顺序签名方式 启用提醒功能以提升完成率

Your First Signature

安全最佳实践 处理敏感文件和区块链交易时，安全性至关重要。本指南概述了在生产环境中部署和维护Chaindoc的核心安全实践。 身份验证与授权 多因素认证（MFA） 请为所有用户账户（尤其是管理员及具有提升权限的用户）始终启用多因素认证（MFA）。Chaindoc支持： 基于时间的一次性密码（TOTP）通过身份验证应用程序 基于短信的验证（安全性较低，仅在必要时使用） 硬件安全密钥（FIDO2/WebAuthn） 在支持设备上进行生物特征认证 强密码策略 实施严格的密码要求： 至少12个字符，并满足复杂度要求 敏感账户的密码有效期为90天 防止密码重复使用（最近10个密码） 连续5次登录失败后将锁定账户 创建过程中的密码强度指示器 基于角色的访问控制（RBAC） 通过仅向用户分配其所需权限来实施最小权限原则： 明确定义角色：查看者、编辑者、管理员、审核员 采用精细化权限管理文档访问 定期审核用户角色并移除不必要的访问权限 为临时承包商实施基于时间的访问权限 关键操作（如审批流程）的职责分离 数据加密 静态数据加密 所有敏感数据存储时必须加密： 采用AES-256加密存储文档 使用独立密钥加密数据库备份 将加密密钥存储在专用的密钥管理服务（KMS）中 每季度轮换加密密钥 在所有服务器和工作站上启用全盘加密 传输中的加密 传输过程中保护数据： 强制所有连接使用 TLS 1.3 使用强加密套件（禁用弱加密算法） 为移动应用程序实现证书固定 启用HSTS（HTTP严格传输安全） 区块链交易须使用加密通道 区块链安全 私钥管理 区块链私钥是最关键的安全资产： 切勿将私钥存储于纯文本或代码仓库中 生产密钥请使用硬件安全模块（HSM） 为高价值操作实现多签名钱包 建立关键备份流程，采用安全的离线存储方案 为不同环境（开发、预发布、生产）使用独立的配置键 智能合约安全 若使用自定义智能合约： 部署前需进行全面的安全审计 使用成熟模式，避免实验性代码 实施断路器实现紧急停止 在主网部署前需在测试网进行充分测试 监控异常交易模式 区块链审计轨迹 利用区块链实现不可篡改的审计日志记录： 将所有文档状态变更记录在链上 对哈希敏感操作进行验证 实施时间戳证明以确保合规性 定期验证链上数据完整性 归档区块链交易收据 API 安全 API 认证 确保所有API端点安全： 使用 OAuth 2.0 或 JWT 令牌进行身份验证 实现令牌过期机制（访问令牌有效期为15-60分钟） 定期轮换API密钥（至少每90天一次） 为不同服务使用独立的API密钥 客户端代码中严禁暴露API密钥 速率限制与DDoS防护 防止滥用及服务中断： 按API密钥和IP地址实施速率限制 对失败请求采用指数退避策略 部署Web应用防火墙（WAF） 在CDN/云服务商层级启用DDoS防护 监控异常流量模式 输入验证与数据净化 防范注入攻击： 对所有输入数据进行严格模式验证 在存储/显示前对用户提供的内容进行安全处理 使用参数化查询以防止SQL注入 实施内容安全策略（CSP）标头 在所有上下文中转义输出（HTML、JavaScript、URL） 基础设施安全 网络分段 隔离关键组件： 将生产环境、预发布环境和开发环境相互隔离 为敏感服务使用虚拟私有云（VPC）和私有子网 仅允许应用服务器访问数据库 实施防火墙规则时采用默认拒绝策略 使用跳板主机/堡垒主机进行管理访问 补丁管理 保持系统更新： 在安全补丁发布后48小时内完成应用 对不影响兼容性的变更自动更新依赖项 定期更新容器镜像和基础操作系统 订阅所有使用技术的安全公告 在生产环境部署前，请先在测试环境中验证补丁 容器与编排安全 若采用容器化部署： 使用最基础的镜像（Alpine、Distroless） 部署前对图像进行漏洞扫描 以非root用户身份运行容器 实施容器安全策略/标准 使用密钥管理（而非环境变量） 启用网络策略以限制Pod间流量 合规与审计 合规要求 确保符合相关法规要求： GDPR：实施删除权和数据可携权 HIPAA：为医疗数据启用审计日志记录和访问控制 SOC 2：记录安全控制措施并执行年度审计 ISO 27001：实施信息安全管理体系 行业特定法规（例如：金融服务、法律） 审计日志记录 为保障安全与合规，须完整保留日志记录： 记录所有身份验证尝试（成功与失败） 记录文档的访问、修改和删除操作 追踪管理操作和配置变更 将日志存储于防篡改的集中化系统中 日志至少保留1年（或按监管要求执行） 为可疑活动实施日志监控与告警机制 定期安全审计 定期进行安全评估： 执行季度漏洞扫描 每年由第三方执行渗透测试 每月审查访问控制和用户权限 审核区块链交易中的异常情况 每季度测试备份与灾难恢复流程 监控与事件响应 安全监控 实施实时安全监控： 部署安全信息与事件管理（SIEM）系统 设置登录失败尝试和权限提升的警报 监控异常数据访问模式 监控API使用异常 使用入侵检测/防御系统（IDS/IPS） 事件响应计划 为安全事件做好准备： 记录事件响应流程 定义升级路径及联系方式 为常见安全场景创建运行手册 每季度开展桌面推演 建立违规行为的沟通协议 保持法证分析能力 备份与灾难恢复 确保业务连续性： 实施自动化的每日备份 将备份存储于地理上分散的位置 加密所有备份数据 每月测试恢复程序 为防范勒索软件，请保持离线备份 文档恢复时间目标（RTO）与恢复点目标（RPO） 开发安全 安全开发生命周期 将安全融入开发： 以安全为重点进行代码审查 使用静态应用程序安全测试（SAST）工具 在CI/CD管道中实现依赖项扫描 要求所有开发人员接受安全培训 切勿将机密信息提交至版本控制系统 使用提交前钩子防止敏感数据泄露 第三方依赖项 管理外部库风险： 定期将依赖项更新至最新安全版本 使用Dependabot、Snyk或npm audit等工具 审查所用软件包的安全公告 尽量减少依赖项数量 验证软件包完整性及维护者信誉 考虑将关键依赖项封装为独立模块 用户教育与意识提升 安全是每个人的责任： 为所有用户开展安全意识培训 提供网络钓鱼与社会工程学教育 制定清晰的安全政策和指南 建立安全问题的报告机制 奖励负责任的漏洞披露 保持安全文档的及时更新 安全检查清单 在部署到生产环境前请使用此检查清单： ✓ 所有用户账户均已启用多因素认证 ✓ 严格执行强密码策略 ✓ 采用最小权限原则实现基于角色的访问控制（RBAC） ✓ 所有数据在静止状态和传输过程中均加密 ✓ 所有端点强制启用 TLS 1.3 ✓ 私钥存储于HSM或安全保险库中 ✓ 已配置API速率限制 ✓ 已启用WAF和DDoS防护 ✓ 已实现输入验证与数据净化 ✓ 网络分段配置正确 ✓ 所有系统均已打补丁并保持最新状态 ✓ 已启用全面审计日志记录 ✓ 安全监控与警报系统已启用 ✓ 事件响应计划已记录并测试 ✓ 已配置并测试自动化备份 ✓ 在持续集成/持续交付（CI/CD）管道中进行安全扫描 ✓ 合规要求已记录并满足 附加资源 有关 Chaindoc 安全性的更多信息： OWASP十大Web应用程序安全风险 美国国家标准与技术研究院网络安全框架 CIS安全基准 区块链安全最佳实践（Consensys） 云安全联盟指南 如遇安全问题或疑问，请通过 security@chaindoc.com 联系我们的安全团队，或通过我们的负责任披露计划报告漏洞。

Security Best Practices

Chaindoc REST API 参考文档 完整指南，助您将Chaindoc的REST API集成至应用程序。管理文档、签名、区块链验证及嵌入式签名工作流。 版本：1.0.0 基础网址：https://api.chaindoc.io/api/v1 认证：API密钥（Bearer令牌） 概述 Chaindoc REST API 提供对文档管理、区块链验证及数字签名功能的程序化访问。该 API 专为服务器间集成设计，同时支持公钥与私钥两种 API 密钥类型。 主要功能 文档管理 - 通过区块链验证创建、更新和管理文档 数字签名 - 向多个方请求并收集数字签名 区块链验证 - 在区块链网络上验证文档真实性 嵌入式会话 - 为前端签名工作流创建安全会话 媒体上传 - 上传文件（PDF、图片、视频）用于文档创建 KYC集成 - 通过Sumsub共享并验证身份数据 认证 Chaindoc API 使用 API 密钥进行身份验证。密钥分为两种类型，具有不同的访问权限级别。 API密钥类型 公钥 (pk_) - 前端应用的只读访问权限及验证 密钥 (sk_) - 后端服务器完整读写权限 客户端代码中严禁暴露密钥 浏览器中仅使用公钥进行只读操作 为保障安全，请定期更换密钥 将密钥存储在环境变量中 获取 API 密钥 订阅商业计划 仅商业版用户可创建API密钥 导航至 API 访问 前往控制台的“设置”→“API访问” 创建 API 密钥 点击创建API密钥按钮 安全存储 安全存储密钥（仅显示一次） 使用 API 密钥 在授权标头中包含您的API密钥，并使用Bearer身份验证： 速率限制 为防止滥用，API 端点均设置了速率限制。不同类型的端点速率限制各不相同。 通用接口：每10秒限3次请求 媒体上传：每10秒3次请求 OTP验证：每60秒限5次请求 读取操作：每60秒10次请求 签名创建：每3秒限20次请求 当超过速率限制时，您将收到429请求过多的响应。响应中包含速率限制标头： 错误处理 HTTP状态码 200 - 成功 201 - 资源创建成功 400 - 请求错误（验证失败） 401 - 未授权（API密钥无效或缺失） 403 - 禁止访问（权限不足） 404 - 资源未找到 429 - 请求过多（超出速率限制） 500 - 服务器内部错误 错误响应格式 通用API 获取API密钥信息 获取当前API密钥的相关信息。 健康检查 验证API连接性和密钥有效性。 文档 API 创建文档 创建具有区块链验证的新文档。当状态设置为"已发布"时，文档将自动在区块链上完成验证。 更新文档 通过创建新版本更新文档。旧版本将被保留以供审计追踪。 更新文档访问权限 更新文档访问控制设置。 验证文档 通过区块链验证文档真实性。返回验证状态及交易哈希值与区块链ID。 获取验证状态 获取文档版本的区块链验证状态。 签名 API 创建签名请求 为一个或多个收件人创建签名请求。启用嵌入式流程以实现前端集成。 获取签名请求状态 查看签名请求的状态，并查看哪些签署人已完成签署。 签署文件 签署文件（若API密钥持有者为签署方）。 获取用户签名 获取已认证用户的全部签名。 获取签名请求 获取认证用户的所有签名请求，支持分页功能。 媒体上传API 上传文件用于文档创建。支持PDF、图片和视频格式。每次请求最多可上传10个文件。 文件格式：PDF、DOC、DOCX、XLS、XLSX、PPT、PPTX、TXT 图片格式：JPG、JPEG、PNG、GIF、WEBP、SVG 视频格式：MP4、AVI、MOV、WMV KYC API 共享KYC数据 向接收方共享KYC（了解你的客户）数据以进行身份验证。 嵌入式会话 API 在前端应用中创建用于文档签名的嵌入式会话。会话有效期为10分钟。 1. 创建嵌入式会话（一次性密码已发送至邮箱） 2. 用户在前端验证一次性密码 3. 前端接收 JWT 令牌 4. 使用令牌调用嵌入式端点

API Documentation

Chaindoc SDKs 官方SDK实现与Chaindoc的无缝集成。全面支持TypeScript，零依赖设计，适用于后端与前端应用的框架无关架构。 可用SDK 服务器SDK（@chaindoc_io/server-sdk）——适用于Node.js 18+的后端集成方案 嵌入式SDK（@chaindoc_io/embed-sdk）——面向网络应用的前端签名接口 Python SDK - 即将推出 PHP SDK - 即将推出 服务器SDK 服务器SDK为Chaindoc API提供类型安全的Node.js接口。可用于管理文档、创建签名请求、处理文件上传，并将区块链验证集成至后端系统。 安装 Node.js 18 或更高版本（使用原生 fetch API） 密钥 API 密钥（sk_live_* 或 sk_test_*） 快速入门 Express.js 集成 Next.js API 路由 错误处理 始终将API调用包裹在try-catch代码块中，并特别处理ChaindocError异常： 嵌入 SDK 嵌入式SDK可将文档签名功能无缝集成至网页应用。该SDK通过iframe框架管理签名流程，确保应用程序与Chaindoc之间的通信安全。 安装 零运行时依赖项 全面支持 TypeScript 框架无关（React、Vue、Angular、Svelte） 轻量级：压缩后小于10KB 安全：来源验证与iframe沙箱机制 基本用法 React 集成 Vue 3 集成 内联模式 请勿使用模态窗口，而是将签名界面直接嵌入页面： 主题设计 通过浅色或深色主题自定义外观： 完整工作流示例 以下是一个结合服务器端SDK和嵌入式SDK的完整端到端示例： 后端：上传文档 使用服务器SDK上传文件并创建文档 后端：创建签名请求 创建签名请求时启用嵌入式流程功能 后端：生成会话 为每位签署人创建嵌入式会话 前端：初始化嵌入式SDK 使用公钥初始化SDK 前端：开启签名流程 使用会话ID打开签名界面 前端：处理成功状态 处理已签名文件并更新用户界面 最佳实践 在每个页面/组件生命周期中仅初始化一次SDK 组件卸载时务必销毁SDK实例 处理所有回调事件（onSuccess、onError、onCancel） 将API密钥存储在环境变量中 使用 TypeScript 实现更优的类型安全 使用 ChaindocError 实现正确的错误处理 在正式部署前使用沙盒密钥进行测试 环境配置 请查阅Webhooks文档获取实时通知功能 阅读REST API参考文档以获取完整的端点文档 在GitHub存储库中探索框架特有的示例

SDKs

Chaindoc Webhooks 当您的Chaindoc账户发生事件时，实时接收通知。Webhooks将事件数据即时推送至您的服务器，无需轮询。 商业版订阅（仅商业版用户可配置 webhook） 服务器上的HTTPS端点 公开可访问的URL（Webhook无法发送至本地主机） 概述 Chaindoc Webhooks 允许您的应用在账户发生事件时接收实时通知。无需轮询 API，一旦操作发生，Webhooks 便会立即将事件数据推送至您的服务器。 主要功能 实时通知 - 即时将事件推送至您的服务器 自动重试 - 支持最多3次重试，采用指数级后退机制 签名验证 - 采用HMAC SHA256确保有效负载真实性 事件过滤 - 仅接收您关注的事件 错误追踪 - 监控Webhook发送状态及失败情况 使用场景 当文件签署时发送邮件通知 当文件在区块链上完成验证时触发工作流 当签名请求创建时更新您的数据库 与外部系统同步文档状态 审计追踪与合规日志记录 设置 步骤1：创建API密钥 在 Chaindoc 仪表盘中导航至“设置 → API 访问”，创建一个启用 webhook 配置的 API 密钥。 步骤 2：配置 Webhook URL 使用API配置您的webhook端点： 步骤3：实现Webhook端点 在服务器上创建一个端点以接收 webhook 事件。以下是不同语言的示例： 活动类型 Chaindoc会在以下事件发生时发送webhook： 文档创建时间 当通过API创建新文档时触发。 document.verified 当文档在区块链上成功验证时触发。 document.signed 当所有必需签名收集完毕时触发。 signature.request.created 当创建新的签名请求时触发。 signature.request.completed 当所有签署人完成签名时触发。 签名请求被拒绝 当签名者拒绝签名请求时触发。 安全 签名验证 Chaindoc使用HMAC SHA256对所有webhook有效负载进行签名。请务必验证签名以确保真实性并防止重放攻击。 始终使用时序安全的比较函数 生产环境中绝不跳过签名验证 请妥善保管您的Webhook密钥 定期轮换密钥 仅使用HTTPS接口 签名验证机制说明 Chaindoc 生成签名 Chaindoc使用您的webhook密钥生成HMAC签名 签名已发送至标题 签名通过X-Webhook-Signature标头发送 您的服务器验证 您的服务器将重新计算签名，并使用时序安全函数进行比对 重试逻辑 Chaindoc会自动对失败的webhook发送进行指数级后退重试。 首次重试：1分钟后 第二次重试：5分钟后（总计：6分钟） 第三次重试：15分钟后（累计：21分钟） 您的端点返回HTTP状态码200-299 您的端点将在30秒内响应 传输过程中未发生网络错误 测试 Webhooks 本地开发 使用ngrok等工具将本地服务器暴露出来进行webhook测试： 手动测试 使用示例有效负载测试您的 webhook 端点： 最佳实践 处理前务必验证Webhook签名 请快速响应（30秒内）以避免超时 在队列中异步处理Webhook 实现幂等性以处理重复事件 记录所有Webhook事件以供调试和审计 在控制台中监控 webhook 发送失败情况 为保障安全，请使用HTTPS接口 优雅处理所有事件类型（忽略未知事件） 完整示例 以下是一个具备数据库集成的生产就绪型Webhook处理程序： 在 Chaindoc 控制台中配置您的 webhook URL 开发期间使用ngrok进行测试 在日志中监控 webhook 交付情况 设置未成功交付的提醒

Webhooks

变更日志 及时了解Chaindoc平台的更新动态、新功能、优化改进及漏洞修复。追踪每次版本发布，确保您的集成始终保持最新状态。 主要版本：每季度发布，包含重大变更与新功能 次要版本：每月发布，包含向后兼容的改进 补丁版本：每周发布，包含错误修复和性能优化 安全更新：按需进行并立即部署 版本 1.0.0 - 2025年12月 正式发布v1.0.0版本，API已稳定 具备完整TypeScript支持的可投入生产环境的SDK 完整的文档和开发者指南 企业级安全与合规性 新功能 🎉 服务器 SDK (@chaindoc_io/server-sdk) - 带自动重试功能的官方 Node.js SDK 🎉 嵌入式SDK (@chaindoc_io/embed-sdk) - 面向React、Vue、Angular的前端签名接口 🎉 Webhooks - 实时事件通知，支持HMAC签名验证 🎉 嵌入式签名流程——在您的应用程序内实现无缝签名体验 🎉 KYC集成 - 通过Sumsub进行身份验证 🎉 访问控制 - 基于角色的精细化权限管理与基于邮箱的访问控制 ✨ 多链支持 - 以太坊、Polygon、BSC、Arbitrum区块链验证 ✨ 批量操作 - 高效上传并处理多份文档 ✨ 高级搜索 - 支持标签和元数据筛选的全文检索 API改进 带详细标头的速率限制（X-RateLimit-*） 改进错误响应，包含字段级验证的详细信息 为所有列表端点提供分页支持 用于监控的健康检查端点 API密钥管理及使用统计 SDK 功能 完整的 TypeScript 定义，支持 IntelliSense 功能 采用指数级后退机制的自动重试逻辑 Embed SDK 零运行时依赖 框架无关的设计（React、Vue、Angular、Svelte） 调试模式用于开发故障排除 安全增强 HMAC SHA256 Webhook签名验证 零停机时间的API密钥轮换 API访问的IP白名单 仪表盘的双因素认证（2FA） SOC 2 类型 II 合规性认证 文档 完整的REST API参考文档，包含所有接口 包含框架示例的SDK文档 Webhooks 设置指南（含代码示例） 集成模式与最佳实践 故障排除指南与常见问题解答 即将推出的功能 用于后端集成的Python SDK 用于旧系统集成的PHP SDK 移动端SDK（iOS和Android） 高级模板系统 批量签名请求 签名界面的定制品牌标识 高级分析仪表盘 请关注我们的GitHub仓库获取最新版本 订阅开发者通讯 加入Discord社区获取最新公告

Changelog

及时了解Chaindoc平台的更新动态、新功能、优化改进及漏洞修复。追踪每次版本发布，确保您的集成始终保持最新状态。