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 | 取得/template/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 定義的身份驗證方案：
