Bitzsoft.Integrations.ElectronicSignature.AdobeSign
1.0.1
dotnet add package Bitzsoft.Integrations.ElectronicSignature.AdobeSign --version 1.0.1
NuGet\Install-Package Bitzsoft.Integrations.ElectronicSignature.AdobeSign -Version 1.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Bitzsoft.Integrations.ElectronicSignature.AdobeSign" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Bitzsoft.Integrations.ElectronicSignature.AdobeSign" Version="1.0.1" />
<PackageReference Include="Bitzsoft.Integrations.ElectronicSignature.AdobeSign" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Bitzsoft.Integrations.ElectronicSignature.AdobeSign --version 1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Bitzsoft.Integrations.ElectronicSignature.AdobeSign, 1.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Bitzsoft.Integrations.ElectronicSignature.AdobeSign@1.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Bitzsoft.Integrations.ElectronicSignature.AdobeSign&version=1.0.1
#tool nuget:?package=Bitzsoft.Integrations.ElectronicSignature.AdobeSign&version=1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Bitzsoft.Integrations.ElectronicSignature.AdobeSign
Adobe Acrobat Sign 电子签章服务实现,基于 Adobe Acrobat Sign REST API v6。
功能特性
- 完整实现
IElectronicSignatureProvider:覆盖合同发起、详情、下载、查看、撤销、签署 URL、签署状态、模板全部统一方法 - OAuth2 Bearer Token 鉴权:简化模型,调用方自行获取 Access Token 后注入
- 协议即合同:Adobe Sign 的 agreement 对应统一抽象的合同/签署流程
- 临时文档上传:发起签署时先通过 transientDocuments 上传文件,再创建协议
- 印章不支持:Adobe Sign 无印章概念,
ListSealsAsync/GetSealDetailAsync抛出NotSupportedException
安装
dotnet add package Bitzsoft.Integrations.ElectronicSignature.AdobeSign
<PackageReference Include="Bitzsoft.Integrations.ElectronicSignature.AdobeSign" Version="1.0.0" />
配置
{
"AdobeSign": {
"BaseUrl": "https://api.na1.adobesign.com/api/rest/v6",
"AccessToken": "your-oauth2-access-token",
"ApiUserEmail": "sender@example.com",
"Timeout": "00:00:30"
}
}
| 参数 | 必填 | 默认值 | 说明 |
|---|---|---|---|
BaseUrl |
是 | https://api.na1.adobesign.com/api/rest/v6 |
分片基地址(NA1 / EU1 / JP1 等) |
AccessToken |
是 | — | OAuth2 Bearer 访问令牌 |
ApiUserEmail |
否 | — | 发起方邮箱,附加到 X-Api-User 头 |
Timeout |
否 | 00:00:30 |
HTTP 请求超时 |
HttpClientName |
否 | AdobeSignElectronicSignatureProvider |
命名 HttpClient 标识 |
WebhookClientId |
否 | — | webhook 客户端密钥 |
注册服务
using Bitzsoft.Integrations.ElectronicSignature.AdobeSign;
// 方式一:IConfiguration(默认读取 "AdobeSign" 配置节)
services.AddBitzsoftAdobeSignElectronicSignature(configuration);
或:
using Bitzsoft.Integrations.ElectronicSignature.AdobeSign;
// 方式二:委托配置
services.AddBitzsoftAdobeSignElectronicSignature(options =>
{
options.BaseUrl = "https://api.na1.adobesign.com/api/rest/v6";
options.AccessToken = "your-oauth2-access-token";
});
API 映射
| 统一方法 | Adobe Sign 端点 | 说明 |
|---|---|---|
CreateContractAsync |
POST /transientDocuments + POST /agreements |
上传临时文档后创建协议 |
GetContractDetailAsync |
GET /agreements/{id} |
含 participantsSetsInfo |
DownloadContractAsync |
GET /agreements/{id}/combinedDocument |
合并后的 PDF |
GetContractViewUrlAsync |
GET /agreements/{id}/signingUrls |
签署/查看 URL |
CancelContractAsync |
PUT /agreements/{id}/state |
state=CANCELLED |
GetSigningUrlAsync |
GET /agreements/{id}/signingUrls |
按 signerId 过滤 |
GetSigningStatusAsync |
GET /agreements/{id}/members |
汇总签署进度 |
ListTemplatesAsync |
GET /libraryDocuments |
库文档列表 |
GetTemplateDetailAsync |
GET /libraryDocuments/{id}/details |
库文档详情 |
ListSealsAsync / GetSealDetailAsync |
— | 抛出 NotSupportedException |
使用示例
// 注入 IElectronicSignatureProvider,ProviderName == "AdobeSign"
var createResult = await provider.CreateContractAsync(new SimpleContractRequest
{
Title = "Master Service Agreement",
FileName = "msa.pdf",
FileData = await File.ReadAllBytesAsync("msa.pdf"),
SignerName = "Jane Smith",
SignerEmail = "jane@example.com"
});
var agreementId = createResult.Data!;
// 查询详情、获取签署页面、下载合同
var detail = await provider.GetContractDetailAsync(agreementId);
var signUrl = await provider.GetSigningUrlAsync(agreementId, "jane@example.com");
var bytes = await provider.DownloadContractAsync(agreementId);
核心类型一览
| 类型 | 说明 |
|---|---|
AdobeSignOptions |
连接配置(BaseUrl / AccessToken / ApiUserEmail / Timeout / HttpClientName) |
AdobeSignElectronicSignatureProvider |
IElectronicSignatureProvider 实现 |
AdobeSignHttpClient |
OAuth2 Bearer 鉴权 HTTP 客户端 |
AdobeSignOptionsValidator |
启动期配置校验 |
依赖
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 is compatible. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- Bitzsoft.Integrations.Compatibility (>= 1.0.1)
- Bitzsoft.Integrations.ElectronicSignature (>= 1.0.1)
- Bitzsoft.Integrations.RequestLogging (>= 1.0.1)
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.10)
- Microsoft.Extensions.Http (>= 10.0.10)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 10.0.10)
-
net5.0
- Bitzsoft.Integrations.Compatibility (>= 1.0.1)
- Bitzsoft.Integrations.ElectronicSignature (>= 1.0.1)
- Bitzsoft.Integrations.RequestLogging (>= 1.0.1)
- Microsoft.Extensions.Configuration.Abstractions (>= 5.0.0)
- Microsoft.Extensions.Http (>= 5.0.0)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 5.0.0)
-
net8.0
- Bitzsoft.Integrations.Compatibility (>= 1.0.1)
- Bitzsoft.Integrations.ElectronicSignature (>= 1.0.1)
- Bitzsoft.Integrations.RequestLogging (>= 1.0.1)
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.10)
- Microsoft.Extensions.Http (>= 10.0.10)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 10.0.10)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Bitzsoft.Integrations.ElectronicSignature.AdobeSign:
| Package | Downloads |
|---|---|
|
Bitzsoft.Integrations.ElectronicSignature.All
电子签章聚合包 — 包含君子签 / 法大大 / 爱签 / 上上签 / e签宝 / 契约锁 / 安证通 / 腾讯电子签 / DocuSign / Adobe Sign 全部实现 |
GitHub repositories
This package is not used by any popular GitHub repositories.