Docuseal API 使用指南：模板与提交管理-优快云博客

Docuseal API 使用指南：模板与提交管理

【免费下载链接】docuseal docusealco/docuseal: DocuSeal 可能是一个文档安全或数字签名解决方案的软件项目，但根据GitHub上信息不足无法确定具体细节。它可能用于保护文档的安全性、提供电子签名功能或者进行文档生命周期管理。项目地址: https://gitcode.com/GitHub_Trending/do/docuseal

前言

Docuseal 是一个功能强大的电子签名和文档管理平台，提供了丰富的 API 接口供开发者集成。本文将详细介绍如何使用 Docuseal API 进行模板管理和提交操作，帮助开发者快速实现文档签名流程的自动化。

模板管理 API

获取模板列表

通过 API 可以获取账户下所有可用的文档模板列表，支持多种过滤条件：

curl --request GET \
  --url https://api.docuseal.com/templates \
  --header 'X-Auth-Token: API_KEY'

可用查询参数：

q：按名称模糊匹配
slug：按唯一标识符精确匹配
external_id：按应用特定标识符过滤
folder：按文件夹名称过滤
archived：是否只获取归档模板
limit：返回结果数量（默认10，最大100）
after/before：基于ID的分页参数

获取单个模板详情

获取指定ID的模板详细信息：

curl --request GET \
  --url https://api.docuseal.com/templates/1000001 \
  --header 'X-Auth-Token: API_KEY'

归档模板

将指定模板归档（非永久删除）：

curl --request DELETE \
  --url https://api.docuseal.com/templates/1000001 \
  --header 'X-Auth-Token: API_KEY'

更新模板信息

修改模板名称或移动模板到其他文件夹：

curl --request PUT \
  --url https://api.docuseal.com/templates/1000001 \
  --header 'X-Auth-Token: API_KEY' \
  --header 'content-type: application/json' \
  --data '{"name":"新文档名称","folder_name":"新文件夹"}'

可更新字段：

name：模板名称
folder_name：目标文件夹名称
roles：提交者角色数组
archived：设为false可取消归档

提交管理 API

获取提交列表

查询所有文档提交记录：

curl --request GET \
  --url https://api.docuseal.com/submissions \
  --header 'X-Auth-Token: API_KEY'

可用查询参数：

template_id：按模板ID过滤
status：按状态过滤（pending/completed/declined/expired）
q：按提交者信息模糊匹配
slug：按唯一标识符精确匹配
template_folder：按模板所在文件夹过滤
archived：是否只获取归档提交
limit/after/before：分页参数

创建新提交

创建签名请求并发送给指定签署人：

curl --request POST \
  --url https://api.docuseal.com/submissions \
  --header 'X-Auth-Token: API_KEY' \
  --header 'content-type: application/json' \
  --data '{
    "template_id":1000001,
    "send_email":true,
    "submitters":[{
      "role":"第一方",
      "email":"john.doe@example.com"
    }]
  }'

主要请求参数说明：

template_id：必填，使用的模板ID
submitters：必填，签署人数组
send_email：是否发送邮件通知（默认true）
send_sms：是否发送短信通知（默认false）
order：签署顺序（preserved/random）
expire_at：设置过期时间
message：自定义通知消息
completed_redirect_url：签署完成后的跳转URL

每个提交者(submitter)可配置：

name：签署人姓名
role：角色名称
email：邮箱地址
phone：手机号码
values：预填字段值
completed：设为true可自动完成签署
fields：字段级配置

最佳实践建议

模板管理：
- 使用文件夹分类管理模板
- 为API创建的模板设置external_id方便后续查询
- 归档不再使用的模板保持界面整洁
提交创建：
- 对于敏感文档，建议设置expire_at
- 多签署人场景考虑使用order参数控制签署顺序
- 利用values参数预填已知信息提升用户体验
错误处理：
- 检查API返回的状态码
- 处理可能的验证错误
- 实现重试机制应对临时性网络问题

通过合理使用这些API，开发者可以轻松将Docuseal的电子签名功能集成到自己的应用中，实现文档签署流程的自动化管理。

创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考