Bitzsoft.Integrations.ElectronicSignature.ESign 1.0.0-alpha.10

Bitzsoft.Integrations.ElectronicSignature.ESign

e签宝电子签章服务实现，基于e签宝开放平台 V3 API。

功能特性

• 完整实现 IElectronicSignatureProvider：覆盖合同发起、详情、下载、查看、撤销、签署 URL、签署状态、印章、模板、回调验签全部统一方法
• HMAC-SHA256 签名鉴权：使用 AppSecret 对请求内容签名，headers 携带 X-Tsign-Open-TIMESTAMP 与签名值
• 回调验签：校验 timestamp + sortedQueryValues + payload 的 HMAC-SHA256 签名，使用 CryptographicOperations.FixedTimeEquals 安全比较
• 扩展 API 端点：通过 QueryGetAsync/QueryPostAsync/QueryUploadAsync/QueryDownloadAsync 访问e签宝全部 67+ API 端点

安装

dotnet add package Bitzsoft.Integrations.ElectronicSignature.ESign

<PackageReference Include="Bitzsoft.Integrations.ElectronicSignature.ESign" Version="1.0.0" />

配置

{
  "ESign": {
    "AppId": "your-app-id",
    "AppSecret": "your-app-secret",
    "BaseUrl": "https://openapi.esign.cn",
    "Timeout": "00:00:30"
  }
}

注册服务

using Bitzsoft.Integrations.ElectronicSignature.ESign;

// 方式一：IConfiguration（默认读取 "ESign" 配置节）
services.AddBitzsoftESignElectronicSignature(configuration);

或：

using Bitzsoft.Integrations.ElectronicSignature.ESign;

// 方式二：委托配置
services.AddBitzsoftESignElectronicSignature(options =>
{
    options.AppId = "your-app-id";
    options.AppSecret = "your-app-secret";
    options.BaseUrl = "https://openapi.esign.cn";
});

请求审计

内置 Bitzsoft.Integrations.RequestLogging 出站请求记录管道，默认 NullRequestLogStore 不持久化。

// ① 默认：启用记录管道但不持久化（日志丢弃）
services.AddBitzsoftESignElectronicSignature(configuration);

// ② 持久化：宿主注册 IRequestLogStore 实现后，所有出站请求自动落库
services.AddRequestLogging<MyRequestLogStore>(opts =>
{
    opts.MaxInMemoryBodyBytes = 64 * 1024; // 仅控制内存/加密临时文件切换，不截断正文
    opts.SensitiveFields.Add("AppSecret");
});
services.AddBitzsoftESignElectronicSignature(configuration);

使用示例

统一抽象

// 注入 IElectronicSignatureProvider，ProviderName == "ESign"
var createResult = await provider.CreateContractAsync(new SimpleContractRequest
{
    Title = "采购合同",
    FileName = "contract.pdf",
    FileData = await File.ReadAllBytesAsync("contract.pdf"),
    SignerName = "张三",
    SignerPhone = "13800000000"
});

var signFlowId = createResult.Data!;

// 获取签署页面、查询签署状态、下载合同
var signUrl = await provider.GetSigningUrlAsync(signFlowId, "signer-id");
var status  = await provider.GetSigningStatusAsync(signFlowId);
var bytes   = await provider.DownloadContractAsync(signFlowId);

扩展 API（partial class）

统一接口仅覆盖极简场景，复杂签署、批量签署、身份认证等通过 ESignElectronicSignatureProvider 的 partial class 方法调用：

var esign = (ESignElectronicSignatureProvider)provider;

// 通用 POST 查询，可访问e签宝全部 67+ 端点
var result = await esign.QueryPostAsync(
    ESignApis.SignFlowCreateByFile,
    body: new { fileId = "file-id", signFlowTitle = "采购合同" });

覆盖端点分组：签署流程（15）、文件管理（5）、合同模板（6）、流程模板（6）、印章服务（8）、身份认证（13）、组织管理（8）。

核心类型一览

依赖

• Bitzsoft.Integrations.Compatibility：基础工具库
• Bitzsoft.Integrations.ElectronicSignature：统一抽象
• Bitzsoft.Integrations.RequestLogging：请求审计

相关包