Docuseal C API 开发指南：模板与提交管理

Docuseal C# API 开发指南：模板与提交管理

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

前言

Docuseal 是一个功能强大的电子签名和文档管理平台，提供了丰富的 API 接口供开发者集成。本文将详细介绍如何使用 C# 语言通过 REST API 与 Docuseal 平台进行交互，重点讲解模板管理和提交操作的相关接口。

准备工作

在开始之前，请确保您已经：

1. 拥有有效的 Docuseal 账户
2. 获取了 API 访问密钥
3. 安装了 C# 开发环境
4. 添加了 RestSharp 或其他 HTTP 客户端库

模板管理 API

1. 获取模板列表

通过此接口可以检索系统中所有可用的文档模板，支持多种过滤条件。

var client = new RestClient("https://api.docuseal.com/templates");
var request = new RestRequest("", Method.Get);
request.AddHeader("X-Auth-Token", "您的API密钥");
var response = client.Execute(request);

参数说明：

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

2. 获取单个模板详情

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

var client = new RestClient("https://api.docuseal.com/templates/1000001");
var request = new RestRequest("", Method.Get);
request.AddHeader("X-Auth-Token", "您的API密钥");
var response = client.Execute(request);

3. 归档模板

将指定模板标记为归档状态，归档后的模板不会出现在默认列表中。

var client = new RestClient("https://api.docuseal.com/templates/1000001");
var request = new RestRequest("", Method.Delete);
request.AddHeader("X-Auth-Token", "您的API密钥");
var response = client.Execute(request);

4. 更新模板信息

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

var client = new RestClient("https://api.docuseal.com/templates/1000001");
var request = new RestRequest("", Method.Put);
request.AddHeader("X-Auth-Token", "您的API密钥");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\"name\":\"新文档名称\",\"folder_name\":\"新文件夹\"}", ParameterType.RequestBody);
var response = client.Execute(request);

可更新字段：

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

提交管理 API

1. 获取提交列表

检索系统中的所有提交记录，支持多种过滤条件。

var client = new RestClient("https://api.docuseal.com/submissions");
var request = new RestRequest("", Method.Get);
request.AddHeader("X-Auth-Token", "您的API密钥");
var response = client.Execute(request);

参数说明：

• template_id：按模板ID过滤
• status：按状态过滤（pending/completed/declined/expired）
• q：按提交者信息部分匹配
• slug：按唯一标识符过滤
• template_folder：按模板文件夹过滤
• archived：是否只返回归档提交
• limit：返回结果数量
• after/before：分页参数

2. 创建新提交

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

var client = new RestClient("https://api.docuseal.com/submissions");
var request = new RestRequest("", Method.Post);
request.AddHeader("X-Auth-Token", "您的API密钥");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\"template_id\":1000001,\"send_email\":true,\"submitters\":[{\"role\":\"第一方\",\"email\":\"john.doe@example.com\"}]}", ParameterType.RequestBody);
var response = client.Execute(request);

关键参数：

• template_id：必需，模板ID
• submitters：必需，签署人数组
• send_email：是否发送邮件通知
• send_sms：是否发送短信通知
• order：签署顺序（preserved/random）
• expire_at：过期时间
• message：自定义通知消息

提交者(submitter)参数：

• name：签署人姓名
• role：角色名称
• email：电子邮箱
• phone：电话号码
• values：预填字段值
• external_id：应用特定标识符
• completed：是否标记为已完成
• fields：字段配置数组

最佳实践

1. 错误处理：始终检查响应状态码并处理可能的错误
2. 分页处理：对于大量数据，使用after/before参数实现分页
3. 安全存储：妥善保管API密钥，不要硬编码在客户端
4. 异步调用：考虑使用异步方法提高应用响应性
5. 日志记录：记录API调用情况以便调试和审计

总结

本文详细介绍了如何使用C#通过Docuseal API进行模板和提交管理。通过这些接口，开发者可以轻松地将电子签名功能集成到自己的应用中，实现文档的自动化处理和签署流程管理。

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