DocuSign eSignature C# Client SDK 使用教程
1. 项目目录结构及介绍
DocuSign eSignature C# Client SDK 的目录结构如下:
docusign-esign-csharp-client/
├── sdk/
│ ├── ... (包含SDK的核心代码)
├── test/
│ ├── ... (包含测试代码)
├── .gitignore
├── .swagger-codegen-ignore
├── CHANGELOG.md
├── LICENSE
├── README.md
目录结构介绍
- sdk/: 包含SDK的核心代码,用于与DocuSign eSignature REST API进行交互。
- test/: 包含SDK的测试代码,用于验证SDK的功能和稳定性。
- .gitignore: Git的忽略文件,指定哪些文件或目录不需要被Git管理。
- .swagger-codegen-ignore: Swagger代码生成器的忽略文件,指定哪些文件或目录不需要被Swagger生成器处理。
- CHANGELOG.md: 记录SDK的版本变更历史。
- LICENSE: SDK的许可证文件,采用MIT许可证。
- README.md: 项目的介绍文件,包含项目的安装、使用说明等信息。
2. 项目的启动文件介绍
DocuSign eSignature C# Client SDK 没有明确的“启动文件”,因为它是一个库,需要集成到你的应用程序中使用。你可以通过NuGet包管理器安装SDK,并在你的项目中引用它。
安装步骤
-
NuGet Package Manager:
- 打开Visual Studio,创建或打开一个C#项目。
- 选择
Tools -> NuGet Package Manager -> Manage NuGet Packages for Solution
。 - 搜索
Docusign
,选择DocuSign.eSign.dll
。 - 勾选你的项目名称,点击
Install
。
-
Package Manager Console:
- 打开Visual Studio,创建或打开一个C#项目。
- 打开
Package Manager Console
(可以通过Tools -> NuGet Package Manager -> Package Manager Console
打开)。 - 在控制台中输入以下命令:
Install-Package DocuSign.eSign.dll
3. 项目的配置文件介绍
DocuSign eSignature C# Client SDK 没有特定的配置文件,但你需要在你的应用程序中配置一些参数来与DocuSign API进行交互。
配置参数
- API Key: 你需要在DocuSign开发者中心获取API Key,用于身份验证。
- OAuth Token: 使用OAuth 2.0进行身份验证,获取访问令牌。
- Base URL: 指定DocuSign API的基地址,通常为
https://demo.docusign.net/restapi
或https://www.docusign.net/restapi
。
示例配置
在你的应用程序中,你可以通过以下方式配置这些参数:
var apiClient = new ApiClient("https://demo.docusign.net/restapi");
var apiClient.Configuration.DefaultHeader.Add("Authorization", "Bearer " + oauthToken);
var envelopesApi = new EnvelopesApi(apiClient);
通过以上配置,你就可以使用DocuSign eSignature C# Client SDK与DocuSign API进行交互了。
以上是DocuSign eSignature C# Client SDK 的使用教程,希望对你有所帮助。