Dropbox Sign v3 API
该 SDK 是根据我们官方维护的 OpenAPI 规范生成的。我们进行了重要更新，引入了新功能并在 Dropbox Sign API 和 SDK 之间实现了功能对等。但是，其中一些更改被视为“破坏性”，因为它们需要您更新现有代码才能继续使用 SDK。请参阅此迁移指南以获取更多信息。
此存储库不再接受新问题或拉取请求。所有问题或 Pull 请求都必须针对 hellosign/hellosign-openapi 存储库打开！
您必须在templates目录中与要更新的文件相对应的 Mustache 文件中进行 SDK 代码更改。
此 C# SDK 由 OpenAPI Generator 项目自动生成：
您必须安装docker （或链接到docker podman ）。强烈建议使用 rootless docker。
运行以下命令，一切都会为您完成：
./run-build注意：运行此命令时，您对 SDK 代码所做的任何更改（未对 OAS 文件和/或 Mustache 模板文件所做的更改）都将丢失。
可以使用 NuGet 包管理器在包名称Dropbox.Sign （包详细信息）下安装 Dropbox Sign .NET SDK。
您可以按照 NuGet 快速入门通过 dotnet CLI 创建和发布包。或者，您可以使用 Visual Studio 创建和发布。
或者，可以将 .nupkg 发布到本地源或其他主机，并像往常一样通过 NuGet 使用。
要将 API 客户端与 HTTP 代理结合使用，请设置System.Net.WebProxy
Configuration c = new Configuration ( ) ;
System . Net . WebProxy webProxy = new System . Net . WebProxy ( " http://myProxyUrl:80/ " ) ;
webProxy . Credentials = System . Net . CredentialCache . DefaultCredentials ;
c . Proxy = webProxy ; using System ;
using Dropbox . Sign . Api ;
using Dropbox . Sign . Client ;
using Dropbox . Sign . Model ;
public class Example
{
public static void Main ( )
{
var config = new Configuration ( ) ;
// Configure HTTP basic authorization: api_key
config . Username = " YOUR_API_KEY " ;
// or, configure Bearer (JWT) authorization: oauth2
// config.AccessToken = "YOUR_BEARER_TOKEN";
var accountApi = new AccountApi ( config ) ;
var data = new AccountCreateRequest (
emailAddress : " [email protected] "
) ;
try
{
var result = accountApi . AccountCreate ( data ) ;
Console . WriteLine ( result ) ;
}
catch ( ApiException e )
{
Console . WriteLine ( " Exception when calling Dropbox Sign API: " + e . Message ) ;
Console . WriteLine ( " Status Code: " + e . ErrorCode ) ;
Console . WriteLine ( e . StackTrace ) ;
}
}
} 所有 URI 均相对于https://api.hellosign.com/v3
| 班级 | 方法 | HTTP请求 | 描述 |
|---|---|---|---|
| 账户API | 创建账户 | POST /帐户/创建 | 创建账户 |
| 账户API | 帐号获取 | 获取/帐户 | 获取账户 |
| 账户API | 账户更新 | 放置/账户 | 更新帐户 |
| 账户API | 账户验证 | POST /帐户/验证 | 验证账户 |
| ApiAppApi | ApiApp创建 | 发布/api_app | 创建API应用程序 |
| ApiAppApi | Api应用程序删除 | 删除/api_app/{client_id} | 删除API应用程序 |
| ApiAppApi | ApiAppGet | 获取/api_app/{client_id} | 获取API应用程序 |
| ApiAppApi | API应用列表 | 获取/api_app/列表 | 列出 API 应用程序 |
| ApiAppApi | API应用程序更新 | PUT /api_app/{client_id} | 更新API应用程序 |
| 批量发送作业API | 批量发送作业获取 | 获取/bulk_send_job/{bulk_send_job_id} | 获取批量发送作业 |
| 批量发送作业API | 批量发送作业列表 | 获取/bulk_send_job/列表 | 列出批量发送作业 |
| 嵌入式API | 嵌入编辑网址 | POST /embedded/edit_url/{template_id} | 获取嵌入模板编辑 URL |
| 嵌入式API | 嵌入式签名Url | 获取/嵌入/sign_url/{signature_id} | 获取嵌入标志 URL |
| 传真API | 传真删除 | 删除/传真/{fax_id} | 删除传真 |
| 传真API | 传真文件 | 获取/传真/文件/{fax_id} | 列出传真文件 |
| 传真API | 传真获取 | 获取/传真/{fax_id} | 获取传真 |
| 传真API | 传真列表 | 获取/传真/列表 | 列出传真 |
| 传真API | 传真发送 | 邮寄/传真/发送 | 发送传真 |
| 传真线路API | 传真线路添加用户 | PUT /fax_line/add_user | 添加传真线路用户 |
| 传真线路API | 传真线路区号获取 | GET /传真线路/地区代码 | 获取可用的传真线路区号 |
| 传真线路API | 传真线路创建 | POST /fax_line/创建 | 购买传真线路 |
| 传真线路API | 传真线路删除 | 删除/fax_line | 删除传真线路 |
| 传真线路API | 传真线路获取 | 获取/传真线路 | 获取传真线路 |
| 传真线路API | 传真线路列表 | 获取/fax_line/列表 | 列出传真线路 |
| 传真线路API | 传真线路删除用户 | PUT /fax_line/remove_user | 删除传真线路访问 |
| OAuthAPI | OauthToken生成 | POST /oauth/令牌 | OAuth 令牌生成 |
| OAuthAPI | OauthToken刷新 | POST /oauth/token?刷新 | OAuth 令牌刷新 |
| 报告API | 报告创建 | 发布/报告/创建 | 创建报告 |
| 签名请求API | SignatureRequestBulkCreateEmbeddedWithTemplate | POST /signature_request/bulk_create_embedded_with_template | 带模板的嵌入式批量发送 |
| 签名请求API | 带模板的签名请求批量发送 | POST /signature_request/bulk_send_with_template | 使用模板批量发送 |
| 签名请求API | 签名请求取消 | POST /signature_request/cancel/{signature_request_id} | 取消不完整的签名请求 |
| 签名请求API | 签名请求创建嵌入式 | POST /signature_request/create_embedded | 创建嵌入式签名请求 |
| 签名请求API | SignatureRequestCreateEmbeddedWithTemplate | POST /signature_request/create_embedded_with_template | 使用模板创建嵌入式签名请求 |
| 签名请求API | 签名请求文件 | 获取/signature_request/files/{signature_request_id} | 下载文件 |
| 签名请求API | 签名请求文件作为数据 Uri | GET /signature_request/files_as_data_uri/{signature_request_id} | 将文件下载为数据 Uri |
| 签名请求API | 签名请求文件AsFileUrl | GET /signature_request/files_as_file_url/{signature_request_id} | 下载文件作为文件 URL |
| 签名请求API | 签名请求获取 | 获取/signature_request/{signature_request_id} | 获取签名请求 |
| 签名请求API | 签名请求列表 | 获取/signature_request/列表 | 列出签名请求 |
| 签名请求API | 签名请求释放保留 | POST /signature_request/release_hold/{signature_request_id} | 释放搁置的签名请求 |
| 签名请求API | 签名请求提醒 | POST /signature_request/remind/{signature_request_id} | 发送请求提醒 |
| 签名请求API | 签名请求删除 | POST /signature_request/remove/{signature_request_id} | 删除签名请求访问权限 |
| 签名请求API | 签名请求发送 | POST /signature_request/发送 | 发送签名请求 |
| 签名请求API | 签名请求使用模板发送 | 发布/signature_request/send_with_template | 使用模板发送 |
| 签名请求API | 签名请求更新 | POST /signature_request/update/{signature_request_id} | 更新签名请求 |
| 团队API | 团队添加成员 | PUT /团队/add_member | 将用户添加到团队 |
| 团队API | 团队创建 | 发布/团队/创建 | 创建团队 |
| 团队API | 团队删除 | 删除/团队/销毁 | 删除团队 |
| 团队API | 团队获取 | 获取/团队 | 获取团队 |
| 团队API | 团队信息 | 获取/团队/信息 | 获取团队信息 |
| 团队API | 团队邀请 | 获取/团队/邀请 | 列出团队邀请 |
| 团队API | 团队成员 | 获取/团队/成员/{team_id} | 列出团队成员 |
| 团队API | 团队删除成员 | 发布/team/remove_member | 从团队中删除用户 |
| 团队API | 团队子团队 | 获取/team/sub_teams/{team_id} | 列出子团队 |
| 团队API | 团队更新 | 放置/团队 | 更新团队 |
| 模板API | 模板添加用户 | POST /template/add_user/{template_id} | 将用户添加到模板 |
| 模板API | 模板创建 | 发布/模板/创建 | 创建模板 |
| 模板API | 模板创建嵌入草稿 | POST /模板/create_embedded_draft | 创建嵌入模板草稿 |
| 模板API | 模板删除 | POST /模板/删除/{template_id} | 删除模板 |
| 模板API | 模板文件 | 获取/模板/文件/{template_id} | 获取模板文件 |
| 模板API | 模板文件作为DataUri | 获取/template/files_as_data_uri/{template_id} | 获取模板文件作为数据 Uri |
| 模板API | 模板文件作为文件 URL | 获取/模板/files_as_file_url/{template_id} | 获取模板文件作为文件 URL |
| 模板API | 模板获取 | 获取/模板/{template_id} | 获取模板 |
| 模板API | 模板列表 | 获取/模板/列表 | 列表模板 |
| 模板API | 模板删除用户 | POST /template/remove_user/{template_id} | 从模板中删除用户 |
| 模板API | 模板更新文件 | POST /template/update_files/{template_id} | 更新模板文件 |
| 无人认领的DraftApi | 无人认领的草稿创建 | POST /unclaimed_draft/create | 创建无人认领的草稿 |
| 无人认领的DraftApi | 无人认领的草稿创建嵌入式 | POST /unclaimed_draft/create_embedded | 创建嵌入式无人认领草稿 |
| 无人认领的DraftApi | 无人认领的草稿用模板创建嵌入式 | POST /unclaimed_draft/create_embedded_with_template | 使用模板创建嵌入式无人认领草稿 |
| 无人认领的DraftApi | 无人认领的草稿编辑并重新发送 | POST /unclaimed_draft/edit_and_resend/{signature_request_id} | 编辑并重新发送无人认领的草稿 |
为 API 定义的身份验证方案：
