通过 BoldSign API 延长文档有效期，保持签署流程活跃

Source: Dev.to

如果你通过 API 来运行电子签名流程，可能已经遇到过这样恼人的边缘情况：自动化的所有步骤都运行良好，直到签署人花的时间比预期更长。文档在不知不觉中过期了，即使交易仍在进行中。

这正是通过 API 延长文档过期时间能够救命的场景。与其把过期时间视为固定设置，你的服务可以根据系统实际情况即时调整——比如还有待处理的机会、经理尚未批准，或合同卡在法务审查阶段。

在本博客中，我们将演示如何通过一次简单的 BoldSign API 调用来延长过期时间，从而让签署流程顺畅进行，避免脆弱的 hack、噪声重试或让利益相关者感到沮丧。

为什么要延长文档过期时间？

• 防止意外过期： 当签署人不可用或错过截止日期时，给予他们更多时间。
• 支持持续谈判： 在讨论进行期间保持文档有效。
• 避免重新发送文档： 更新过期时间，无需重新创建模板或再次配置字段。
• 确保合规性： 受监管的工作流通常需要更长的审查时间。

BoldSign 中的过期类型

BoldSign 支持三种过期配置：

• 天数： yyyy-MM-dd（例如 2025-10-15）
• 小时数： 整数（例如 12）
• 具体日期和时间： ISO 格式（例如 2025-10-15T10:58:04Z）

如何使用 BoldSign API 延长过期时间

步骤 1：获取文档属性

在延长文档的过期日期之前，必须先检查其当前的 expiryDateType 和 expiryValue。使用 BoldSign API 获取文档属性：

GET /v1/document/properties

参考官方文档：Get Document Properties API

响应中会包含文档的所有相关细节，包括已添加的表单以及过期配置（expiryDateType 和 expiryValue）。

步骤 2：延长过期日期

确定了 expiryDateType 后，使用以下请求更新文档的过期时间：

curl -X PATCH "https://api.boldsign.com/v1/document/extendExpiry?documentId={documentId}" \
     -H 'X-API-KEY: {your API key}' \
     -H "Content-Type: application/json" \
     -d '{"newExpiryValue": "2025-12-15", "warnPrior": true}'

更新过期日期的重要属性和规则

• documentId – 要更新的文档 ID。
• newExpiryValue – 格式取决于原始的过期类型：
  • 天数 → yyyy-MM-dd
  • 小时 → 整数值
  • 具体日期和时间 → ISO 格式
• warnPrior – 控制提醒行为：
  • true – 在过期前 1 天发送提醒
  • false – 关闭提醒
  • null – 保持现有配置

其他规则：

• 新的过期时间必须大于或晚于当前的过期时间。
• 过期时间不得超过文档创建后 180 天。

成功更新后返回 200 OK 并附带新的过期详情。

延长文档过期的关键好处

• 更高的灵活性： 根据项目进度或客户可用性调整过期日期，无需重新开始。
• 提升完成率： 给收件人更多时间，可增加文档签署并返回的概率。
• 更好的用户体验： 当延误不可避免时，签署人会感激额外的时间。
• 提升工作流效率： 让文档流水线顺畅运行，避免因链接过期而中断。

结论

延误是不可避免的——但重新启动签署工作流并非唯一选择。借助 BoldSign 的过期延长 API，你可以应对日常挑战，让文档持续前进。

准备好尝试了吗？
查看 BoldSign API 文档 中的 API 参考，并注册一个 免费沙盒账户 开始使用。

本文最初发布于 boldsign.com。