Dropbox Sign v3-API
Dieses SDK wird aus unserer offiziell gepflegten OpenAPI-Spezifikation generiert. Wir haben wichtige Updates vorgenommen, die neue Funktionen einführen und Funktionsparität zwischen der Dropbox Sign API und dem SDK schaffen. Einige dieser Änderungen gelten jedoch als „bahnbrechend“ in dem Sinne, dass Sie Ihren vorhandenen Code aktualisieren müssen, um das SDK weiterhin verwenden zu können. Weitere Informationen finden Sie in diesem Migrationsleitfaden.
Dieses Repo akzeptiert keine neuen Issues oder Pull Requests mehr. Alle Issues oder Pull Requests müssen gegen das hellosign/hellosign-openapi Repo geöffnet werden!
Sie müssen Änderungen am SDK-Code in der Moustache-Datei im templates vornehmen, die der Datei entspricht, die Sie aktualisieren möchten.
Dieses C# SDK wird automatisch vom OpenAPI Generator-Projekt generiert:
Sie müssen docker (oder einen mit docker verknüpften podman ) installiert haben. Es wird dringend empfohlen, Rootless Docker zu verwenden.
Führen Sie Folgendes aus und alles wird für Sie erledigt:
./run-buildAchtung : Alle Änderungen, die Sie am SDK-Code vorgenommen haben, die Sie nicht an der OAS-Datei und/oder den Moustache-Vorlagendateien vorgenommen haben, gehen verloren , wenn Sie diesen Befehl ausführen.
Das Dropbox Sign .NET SDK kann mit dem NuGet-Paketmanager unter dem Paketnamen Dropbox.Sign (Paketdetails) installiert werden.
Sie können der NuGet-Schnellstartanleitung folgen, um das Paket über die Dotnet-CLI zu erstellen und zu veröffentlichen. Oder Sie können mit Visual Studio erstellen und veröffentlichen.
Alternativ kann die .nupkg-Datei in einem lokalen Feed oder einem anderen Host veröffentlicht und wie gewohnt über NuGet genutzt werden.
Um den API-Client mit einem HTTP-Proxy zu verwenden, richten Sie einen System.Net.WebProxy ein
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 ) ;
}
}
} Alle URIs beziehen sich auf https://api.hellosign.com/v3
| Klasse | Verfahren | HTTP-Anfrage | Beschreibung |
|---|---|---|---|
| AccountApi | KontoErstellen | POST /Konto/Erstellen | Benutzerkonto erstellen |
| AccountApi | AccountGet | GET /Konto | Konto anfordern |
| AccountApi | Kontoaktualisierung | PUT /Konto | Konto aktualisieren |
| AccountApi | AccountVerify | POST /account/verify | Konto bestätigen |
| ApiAppApi | ApiAppCreate | POST /api_app | Erstellen Sie eine API-App |
| ApiAppApi | ApiAppDelete | /api_app/{client_id} LÖSCHEN | API-App löschen |
| ApiAppApi | ApiAppGet | GET /api_app/{client_id} | Holen Sie sich die API-App |
| ApiAppApi | ApiAppList | GET /api_app/list | API-Apps auflisten |
| ApiAppApi | ApiAppUpdate | PUT /api_app/{client_id} | API-App aktualisieren |
| BulkSendJobApi | BulkSendJobGet | GET /bulk_send_job/{bulk_send_job_id} | Holen Sie sich einen Massenversandauftrag |
| BulkSendJobApi | BulkSendJobList | GET /bulk_send_job/list | Massenversandaufträge auflisten |
| EmbeddedApi | EmbeddedEditUrl | POST /embedded/edit_url/{template_id} | Rufen Sie die Bearbeitungs-URL der eingebetteten Vorlage ab |
| EmbeddedApi | EmbeddedSignUrl | GET /embedded/sign_url/{signature_id} | Holen Sie sich die eingebettete Sign-URL |
| FaxApi | FaxLöschen | LÖSCHEN /fax/{fax_id} | Fax löschen |
| FaxApi | Faxdateien | GET /fax/files/{fax_id} | Faxdateien auflisten |
| FaxApi | FaxGet | GET /fax/{fax_id} | Holen Sie sich ein Fax |
| FaxApi | Faxliste | GET /fax/list | Listet Faxe auf |
| FaxApi | FaxSenden | POST /Fax/Senden | Fax senden |
| FaxLineApi | FaxLineAddUser | PUT /fax_line/add_user | Faxleitungsbenutzer hinzufügen |
| FaxLineApi | FaxLineAreaCodeGet | GET /fax_line/area_codes | Verfügbare Vorwahlen für Faxleitungen abrufen |
| FaxLineApi | FaxLineCreate | POST /fax_line/create | Kaufen Sie eine Faxleitung |
| FaxLineApi | FaxLineDelete | /fax_line löschen | Faxleitung löschen |
| FaxLineApi | FaxLineGet | GET /fax_line | Holen Sie sich eine Faxleitung |
| FaxLineApi | FaxLineList | GET /fax_line/list | Faxleitungen auflisten |
| FaxLineApi | FaxLineRemoveUser | PUT /fax_line/remove_user | Entfernen Sie den Zugriff auf die Faxleitung |
| OAuthApi | OauthTokenGenerate | POST /oauth/token | OAuth-Token generieren |
| OAuthApi | OAuthTokenRefresh | POST /oauth/token?refresh | Aktualisierung des OAuth-Tokens |
| ReportApi | BerichtErstellen | POST /report/create | Bericht erstellen |
| SignatureRequestApi | SignatureRequestBulkCreateEmbeddedWithTemplate | POST /signature_request/bulk_create_embedded_with_template | Eingebetteter Massenversand mit Vorlage |
| SignatureRequestApi | SignatureRequestBulkSendWithTemplate | POST /signature_request/bulk_send_with_template | Massenversand mit Vorlage |
| SignatureRequestApi | SignatureRequestCancel | POST /signature_request/cancel/{signature_request_id} | Unvollständige Signaturanforderung abbrechen |
| SignatureRequestApi | SignatureRequestCreateEmbedded | POST /signature_request/create_embedded | Erstellen Sie eine eingebettete Signaturanforderung |
| SignatureRequestApi | SignatureRequestCreateEmbeddedWithTemplate | POST /signature_request/create_embedded_with_template | Erstellen Sie eine eingebettete Signaturanforderung mit Vorlage |
| SignatureRequestApi | SignatureRequestFiles | GET /signature_request/files/{signature_request_id} | Dateien herunterladen |
| SignatureRequestApi | SignatureRequestFilesAsDataUri | GET /signature_request/files_as_data_uri/{signature_request_id} | Laden Sie Dateien als Daten-URI herunter |
| SignatureRequestApi | SignatureRequestFilesAsFileUrl | GET /signature_request/files_as_file_url/{signature_request_id} | Laden Sie Dateien als Datei-URL herunter |
| SignatureRequestApi | SignatureRequestGet | GET /signature_request/{signature_request_id} | Holen Sie sich eine Signaturanforderung |
| SignatureRequestApi | SignatureRequestList | GET /signature_request/list | Signaturanfragen auflisten |
| SignatureRequestApi | SignatureRequestReleaseHold | POST /signature_request/release_hold/{signature_request_id} | Geben Sie die Signaturanforderung für die Warteschleife frei |
| SignatureRequestApi | SignatureRequestRemind | POST /signature_request/remind/{signature_request_id} | Anfrageerinnerung senden |
| SignatureRequestApi | SignatureRequestRemove | POST /signature_request/remove/{signature_request_id} | Entfernen Sie den Signaturanforderungszugriff |
| SignatureRequestApi | SignatureRequestSend | POST /signature_request/send | Signaturanfrage senden |
| SignatureRequestApi | SignatureRequestSendWithTemplate | POST /signature_request/send_with_template | Mit Vorlage senden |
| SignatureRequestApi | SignatureRequestUpdate | POST /signature_request/update/{signature_request_id} | Signaturanforderung aktualisieren |
| TeamApi | TeamAddMember | PUT /team/add_member | Benutzer zum Team hinzufügen |
| TeamApi | TeamCreate | POST /team/create | Team erstellen |
| TeamApi | TeamDelete | DELETE /team/destroy | Team löschen |
| TeamApi | TeamGet | GET /team | Holen Sie sich Team |
| TeamApi | TeamInfo | GET /team/info | Holen Sie sich Teaminformationen |
| TeamApi | TeamInvites | GET /team/invites | Teameinladungen auflisten |
| TeamApi | Teammitglieder | GET /team/members/{team_id} | Teammitglieder auflisten |
| TeamApi | TeamRemoveMember | POST /team/remove_member | Benutzer aus Team entfernen |
| TeamApi | TeamSubTeams | GET /team/sub_teams/{team_id} | Subteams auflisten |
| TeamApi | TeamUpdate | PUT /Team | Update-Team |
| TemplateApi | TemplateAddUser | POST /template/add_user/{template_id} | Benutzer zur Vorlage hinzufügen |
| TemplateApi | Vorlage erstellen | POST /template/create | Vorlage erstellen |
| TemplateApi | TemplateCreateEmbeddedDraft | POST /template/create_embedded_draft | Erstellen Sie einen eingebetteten Vorlagenentwurf |
| TemplateApi | TemplateDelete | POST /template/delete/{template_id} | Vorlage löschen |
| TemplateApi | Vorlagendateien | GET /template/files/{template_id} | Holen Sie sich Vorlagendateien |
| TemplateApi | TemplateFilesAsDataUri | GET /template/files_as_data_uri/{template_id} | Holen Sie sich Vorlagendateien als Daten-URI |
| TemplateApi | TemplateFilesAsFileUrl | GET /template/files_as_file_url/{template_id} | Holen Sie sich Vorlagendateien als Datei-URL |
| TemplateApi | TemplateGet | GET /template/{template_id} | Holen Sie sich eine Vorlage |
| TemplateApi | Vorlagenliste | GET /template/list | Listenvorlagen |
| TemplateApi | TemplateRemoveUser | POST /template/remove_user/{template_id} | Benutzer aus Vorlage entfernen |
| TemplateApi | TemplateUpdateFiles | POST /template/update_files/{template_id} | Vorlagendateien aktualisieren |
| Nicht beanspruchter EntwurfApi | Nicht beanspruchter EntwurfErstellen | POST /unclaimed_draft/create | Erstellen Sie einen nicht beanspruchten Entwurf |
| Nicht beanspruchter EntwurfApi | Nicht beanspruchtDraftCreateEmbedded | POST /unclaimed_draft/create_embedded | Erstellen Sie einen eingebetteten, nicht beanspruchten Entwurf |
| Nicht beanspruchter EntwurfApi | UnclaimedDraftCreateEmbeddedWithTemplate | POST /unclaimed_draft/create_embedded_with_template | Erstellen Sie einen eingebetteten nicht beanspruchten Entwurf mit Vorlage |
| Nicht beanspruchter EntwurfApi | UnclaimedDraftEditAndResend | POST /unclaimed_draft/edit_and_resend/{signature_request_id} | Nicht beanspruchten Entwurf bearbeiten und erneut senden |
Für die API definierte Authentifizierungsschemata:
