Dropbox 署名 v3 API
この SDK は、公式に保守されている OpenAPI 仕様から生成されています。新しい機能を導入し、Dropbox Sign API と SDK の間で同等の機能を実現する重要なアップデートを行いました。ただし、これらの変更の一部は、SDK を引き続き使用するために既存のコードを更新する必要があるという意味で「破壊的」と見なされます。詳細については、この移行ガイドを参照してください。
このリポジトリは新しい問題やプル リクエストを受け付けなくなりました。すべての問題またはプル リクエストは、hellosign/hellosign-openapi リポジトリに対してオープンする必要があります。
更新するファイルに対応するtemplatesディレクトリ内のヒゲ ファイルで SDK コードを変更する必要があります。
この C# SDK は、OpenAPI Generator プロジェクトによって自動的に生成されます。
docker (またはdockerにリンクされたpodman ) がインストールされている必要があります。 rootless Docker を使用することを強くお勧めします。
以下を実行すると、すべてが完了します。
./run-build注意: このコマンドを実行すると、OAS ファイルやヒゲ テンプレート ファイルに加えていない、SDK コードに加えた変更はすべて失われます。
Dropbox Sign .NET SDK は、NuGet パッケージ マネージャーを使用して、パッケージ名Dropbox.Signでインストールできます (パッケージの詳細)。
NuGet クイックスタートに従って、dotnet CLI 経由でパッケージを作成および公開できます。または、Visual Studio を使用して作成して公開することもできます。
あるいは、.nupkg をローカル フィードまたは他のホストに公開し、通常どおり NuGet 経由で使用することもできます。
HTTP プロキシで API クライアントを使用するには、 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 | アカウント取得 | GET /アカウント | アカウントを取得する |
| アカウントAPI | アカウント更新 | PUT /アカウント | アカウントを更新する |
| アカウントAPI | アカウント確認 | POST /アカウント/検証 | アカウントの確認 |
| アピアプリアピ | APIAppCreate | POST /api_app | APIアプリの作成 |
| アピアプリアピ | APIApp削除 | /api_app/{client_id}を削除します | APIアプリの削除 |
| アピアプリアピ | APIAppGet | /api_app/{client_id}を取得する | APIアプリを入手 |
| アピアプリアピ | APIAppList | /api_app/list を取得する | API アプリの一覧表示 |
| アピアプリアピ | APIAppUpdate | PUT /api_app/{client_id} | APIアプリを更新する |
| BulkSendJobApi | 一括送信ジョブ取得 | /bulk_send_job/{bulk_send_job_id}を取得 | 一括送信ジョブの取得 |
| BulkSendJobApi | 一括送信ジョブリスト | GET /bulk_send_job/list | 一括送信ジョブの一覧表示 |
| 埋め込みAPI | 埋め込み編集URL | POST /embedded/edit_url/{template_id} | 埋め込みテンプレートの取得 URL の編集 |
| 埋め込みAPI | 埋め込み署名URL | /embedded/sign_url/{signature_id}を取得 | 埋め込み署名の URL を取得する |
| FAXApi | FAX削除 | /fax/{fax_id}を削除します | ファクスの削除 |
| FAXApi | FAXファイル | /fax/files/{fax_id}を取得する | FAXファイルの一覧表示 |
| FAXApi | ファックス取得 | /fax/{fax_id}を取得する | ファックスを受け取る |
| FAXApi | FAXリスト | GET /fax/リスト | FAXのリスト |
| FAXApi | ファックス送信 | POST /ファックス/送信 | ファックスを送信する |
| FAXLineApi | FAXLineAddUser | PUT /fax_line/add_user | FAX回線ユーザーの追加 |
| FAXLineApi | FAX回線エリアコード取得 | /FAX回線/エリアコードを取得する | 利用可能な FAX 回線の市外局番を取得する |
| FAXLineApi | FAX回線作成 | POST /fax_line/create | FAX回線を購入する |
| FAXLineApi | FAXLine削除 | /fax_lineを削除 | FAX回線の削除 |
| FAXLineApi | FAXLineGet | GET /fax_line | ファックス回線を取得する |
| FAXLineApi | FAX回線リスト | /fax_line/リストを取得する | ファックス回線の一覧表示 |
| FAXLineApi | FAXLineRemoveUser | PUT /fax_line/remove_user | FAX 回線アクセスの削除 |
| OAuthApi | OauthTokenGenerate | POST /oauth/トークン | OAuth トークンの生成 |
| OAuthApi | OauthTokenRefresh | POST /oauth/token?refresh | OAuth トークンの更新 |
| レポートAPI | レポート作成 | POST /レポート/作成 | レポートの作成 |
| SignatureRequestApi | 署名リクエスト一括作成EmbeddedWithTemplate | POST /signature_request/bulk_create_embedded_with_template | テンプレートを使用した埋め込み一括送信 |
| SignatureRequestApi | 署名リクエストテンプレート付き一括送信 | POST /signature_request/bulk_send_with_template | テンプレートを使用した一括送信 |
| SignatureRequestApi | 署名リクエストキャンセル | POST /signature_request/cancel/{signature_request_id} | 不完全な署名リクエストのキャンセル |
| SignatureRequestApi | 署名リクエスト作成埋め込み | POST /signature_request/create_embedded | 埋め込み署名リクエストの作成 |
| SignatureRequestApi | 署名リクエスト作成埋め込みテンプレート付き | POST /signature_request/create_embedded_with_template | テンプレートを使用して埋め込み署名リクエストを作成する |
| SignatureRequestApi | 署名リクエストファイル | GET /signature_request/files/{signature_request_id} | ファイルをダウンロードする |
| SignatureRequestApi | SignatureRequestFilesAsDataUri | GET /signature_request/files_as_data_uri/{signature_request_id} | ファイルをデータ URI としてダウンロードする |
| SignatureRequestApi | SignatureRequestFilesAsFileUrl | GET /signature_request/files_as_file_url/{signature_request_id} | ファイルをファイル URL としてダウンロード |
| SignatureRequestApi | 署名リクエスト取得 | GET /signature_request/{signature_request_id} | 署名リクエストの取得 |
| SignatureRequestApi | 署名リクエストリスト | GET /signature_request/list | 署名リクエストのリスト |
| SignatureRequestApi | 署名リクエストリリースホールド | POST /signature_request/release_hold/{signature_request_id} | 保留中の署名リクエストの解除 |
| SignatureRequestApi | 署名リクエストリマインド | POST /signature_request/remind/{signature_request_id} | リクエスト送信リマインダー |
| SignatureRequestApi | 署名リクエスト削除 | POST /signature_request/remove/{signature_request_id} | 署名の削除リクエストのアクセス |
| SignatureRequestApi | 署名リクエスト送信 | POST /signature_request/send | 署名リクエストの送信 |
| SignatureRequestApi | 署名リクエストテンプレートを使用して送信 | POST /signature_request/send_with_template | テンプレートで送信 |
| SignatureRequestApi | 署名リクエスト更新 | POST /signature_request/update/{signature_request_id} | 署名の更新リクエスト |
| チームアピ | チームメンバーの追加 | PUT /チーム/add_member | ユーザーをチームに追加 |
| チームアピ | チーム作成 | POST /チーム/作成 | チームの作成 |
| チームアピ | チーム削除 | /チーム/破壊を削除 | チームの削除 |
| チームアピ | チームゲット | GET /チーム | チームを取得する |
| チームアピ | チーム情報 | /チーム/情報を取得する | チーム情報を取得する |
| チームアピ | チーム招待 | /チーム/招待を取得 | チームの招待をリストする |
| チームアピ | チームメンバー | /team/members/{team_id}を取得する | チームメンバーをリストする |
| チームアピ | チームメンバーの削除 | POST /チーム/remove_member | チームからユーザーを削除 |
| チームアピ | チームサブチーム | /team/sub_teams/{team_id}を取得する | サブチームをリストする |
| チームアピ | チームアップデート | PUT /チーム | アップデートチーム |
| テンプレートAPI | テンプレートユーザーの追加 | POST /template/add_user/{template_id} | ユーザーをテンプレートに追加 |
| テンプレートAPI | テンプレート作成 | POST /テンプレート/作成 | テンプレートの作成 |
| テンプレートAPI | テンプレート作成埋め込みドラフト | POST /template/create_embedded_draft | 埋め込みテンプレートのドラフトを作成する |
| テンプレートAPI | テンプレート削除 | POST /template/delete/{template_id} | テンプレートの削除 |
| テンプレートAPI | テンプレートファイル | /template/files/{template_id}を取得します | テンプレートファイルを取得する |
| テンプレートAPI | TemplateFilesAsDataUri | /template/files_as_data_uri/{template_id}を取得します | テンプレート ファイルをデータ URI として取得する |
| テンプレートAPI | TemplateFilesAsFileUrl | GET /template/files_as_file_url/{template_id} | テンプレート ファイルをファイル URL として取得 |
| テンプレートAPI | テンプレート取得 | /template/{template_id}を取得します | テンプレートの取得 |
| テンプレートAPI | テンプレートリスト | GET /テンプレート/リスト | リストテンプレート |
| テンプレートAPI | テンプレートユーザーの削除 | POST /template/remove_user/{template_id} | テンプレートからユーザーを削除 |
| テンプレートAPI | テンプレート更新ファイル | POST /template/update_files/{template_id} | テンプレートファイルの更新 |
| 未請求のドラフト API | 未請求ドラフト作成 | POST /unclaimed_draft/create | 請求されていないドラフトを作成する |
| 未請求ドラフト API | 未請求ドラフト作成埋め込み | POST /unclaimed_draft/create_embedded | 埋め込み未請求ドラフトの作成 |
| 未請求ドラフト API | 未請求ドラフト作成埋め込みテンプレート付き | POST /unclaimed_draft/create_embedded_with_template | テンプレートを使用して埋め込み未請求ドラフトを作成する |
| 未請求のドラフト API | 請求されていないドラフト編集と再送信 | POST /unclaimed_draft/edit_and_resend/{signature_request_id} | 請求されていないドラフトを編集して再送信する |
API に対して定義された認証スキーム:
