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

Bitzsoft.Integrations.ElectronicSignature.BestSign

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

功能特性

• 完整实现 IElectronicSignatureProvider：覆盖合同发起、详情、下载、查看、撤销、签署 URL、签署状态、印章、模板、回调验签全部统一方法
• OAuth2 + RSA256 双层鉴权：clientId+clientSecret 换取 access_token（自动刷新），请求体 MD5 → headers 字典序拼接 → RSA-SHA256 签名
• 回调验签：校验 developerId 匹配、时间戳新鲜度、RSA 签名（与出站签名算法对称），callbackHeaders 为空直接拒绝
• partial class 扩展：通过部分类暴露上上签全部 API（签署、模板、用户、实名认证、证据报告）

安装

dotnet add package Bitzsoft.Integrations.ElectronicSignature.BestSign

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

配置

{
  "BestSign": {
    "ClientId": "your-client-id",
    "ClientSecret": "your-client-secret",
    "DeveloperId": "your-developer-id",
    "PrivateKey": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----",
    "PublicKey": "-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----",
    "BaseUrl": "https://openapi.bestsign.cn",
    "Timeout": "00:00:30"
  }
}

注册服务

using Bitzsoft.Integrations.ElectronicSignature.BestSign;

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

或：

using Bitzsoft.Integrations.ElectronicSignature.BestSign;

// 方式二：委托配置
services.AddBitzsoftBestSignElectronicSignature(options =>
{
    options.ClientId = "your-client-id";
    options.ClientSecret = "your-client-secret";
    options.DeveloperId = "your-developer-id";
    options.PrivateKey = File.ReadAllText("private_key.pem");
    options.PublicKey = File.ReadAllText("public_key.pem");
    options.BaseUrl = "https://openapi.bestsign.cn";
});

请求审计

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

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

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

使用示例

统一抽象

// 注入 IElectronicSignatureProvider，ProviderName == "BestSign"
// 上上签流程：上传文件 → 发起签署，返回合同编号
var createResult = await provider.CreateContractAsync(new SimpleContractRequest
{
    Title = "采购合同",
    FileName = "contract.pdf",
    FileData = await File.ReadAllBytesAsync("contract.pdf"),
    SignerName = "张三",
    SignerPhone = "13800000000"
});

var contractNo = createResult.Data!;

// 查询详情、获取签署页面、下载合同
var detail  = await provider.GetContractDetailAsync(contractNo);
var signUrl = await provider.GetSigningUrlAsync(contractNo, "account");
var bytes   = await provider.DownloadContractAsync(contractNo);

扩展 API（partial class）

统一接口仅覆盖极简场景，复杂签署、模板、用户、认证、证据报告等通过 BestSignElectronicSignatureProvider 的 partial class 方法调用：

var bestSign = (BestSignElectronicSignatureProvider)provider;

// 通用 POST 查询
var result = await bestSign.QueryPostAsync(BestSignApis.StartSign, body: new { /* ... */ });

扩展方法按领域拆分：Signing（9）、Templates（7）、Users（8）、Verification（5）、Evidence（3）。

核心类型一览

依赖

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

相关包