API Dropbox Signv3
Ce SDK est généré à partir de notre spécification OpenAPI officiellement maintenue. Nous avons effectué des mises à jour importantes qui introduisent de nouvelles fonctionnalités et créent une parité de fonctionnalités entre l'API Dropbox Sign et le SDK. Cependant, certaines de ces modifications sont considérées comme « cassantes » dans le sens où elles vous obligeront à mettre à jour votre code existant afin de continuer à utiliser le SDK. Veuillez vous référer à ce guide de migration pour plus d'informations.
Ce dépôt n'accepte plus de nouveaux problèmes ou de demandes d'extraction. Tous les tickets ou Pull Requests doivent être ouverts sur le dépôt hellosign/hellosign-openapi !
Vous devez apporter des modifications au code du SDK dans le fichier moustache dans le répertoire templates qui correspond au fichier que vous souhaitez mettre à jour.
Ce SDK C# est automatiquement généré par le projet OpenAPI Generator :
Vous devez avoir docker (ou podman lié à docker ) installé. Il est fortement recommandé d'utiliser un docker sans racine.
Exécutez ce qui suit et tout est fait pour vous :
./run-buildAttention : Toutes les modifications que vous avez apportées au code du SDK et que vous n'avez pas apportées au fichier OAS et/ou aux fichiers de modèle de moustache seront perdues lorsque vous exécuterez cette commande.
Le SDK Dropbox Sign .NET peut être installé à l'aide du gestionnaire de packages NuGet, sous le nom du package Dropbox.Sign (détails du package).
Vous pouvez suivre le démarrage rapide de NuGet pour créer et publier le package via la CLI dotnet. Vous pouvez également créer et publier à l’aide de Visual Studio.
Alternativement, le .nupkg peut être publié sur un flux local ou un autre hôte et consommé via NuGet comme d'habitude.
Pour utiliser le client API avec un proxy HTTP, configurez un 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 ) ;
}
}
} Tous les URI sont relatifs à https://api.hellosign.com/v3
| Classe | Méthode | Requête HTTP | Description |
|---|---|---|---|
| CompteApi | CompteCréer | POST /compte/créer | Créer un compte |
| CompteApi | CompteObtenir | OBTENIR /compte | Obtenir un compte |
| CompteApi | Mise à jour du compte | METTRE /compte | Mettre à jour le compte |
| CompteApi | CompteVérifier | POST /compte/vérifier | Vérifier le compte |
| APIAppApi | ApiAppCréer | POST /api_app | Créer une application API |
| APIAppApi | ApiAppSupprimer | SUPPRIMER /api_app/{client_id} | Supprimer l'application API |
| APIAppApi | ApiAppObtenir | OBTENIR /api_app/{client_id} | Obtenir l'application API |
| APIAppApi | Liste des applications API | OBTENIR /api_app/list | Répertorier les applications API |
| APIAppApi | ApiAppMise à jour | METTRE /api_app/{client_id} | Mettre à jour l'application API |
| BulkSendJobApi | BulkSendJobGet | OBTENIR /bulk_send_job/{bulk_send_job_id} | Obtenir un travail d'envoi groupé |
| BulkSendJobApi | BulkSendJobList | OBTENIR /bulk_send_job/list | Répertorier les tâches d'envoi groupé |
| API intégrée | URL de modification intégrée | POST /embedded/edit_url/{template_id} | Obtenir le modèle intégré Modifier l'URL |
| API intégrée | EmbeddedSignUrl | OBTENIR /embedded/sign_url/{signature_id} | Obtenir l'URL du signe intégré |
| FaxApi | FaxSupprimer | SUPPRIMER /fax/{fax_id} | Supprimer le fax |
| FaxApi | Fichiers de télécopie | OBTENIR /fax/files/{fax_id} | Liste des fichiers de télécopie |
| FaxApi | FaxObtenir | OBTENIR /fax/{fax_id} | Obtenir un fax |
| FaxApi | Liste de fax | OBTENIR /fax/liste | Listes de fax |
| FaxApi | Envoi de fax | POST /fax/envoi | Envoyer un fax |
| FaxLineApi | FaxLineAddUser | PUT /fax_line/add_user | Ajouter un utilisateur de ligne de fax |
| FaxLineApi | FaxLineAreaCodeObtenir | OBTENIR /fax_line/area_codes | Obtenez les indicatifs régionaux des lignes de fax disponibles |
| FaxLineApi | FaxLineCréer | POST /fax_line/create | Acheter une ligne de télécopie |
| FaxLineApi | FaxLineSupprimer | SUPPRIMER /fax_line | Supprimer la ligne de télécopie |
| FaxLineApi | FaxLineObtenir | OBTENIR /fax_line | Obtenir une ligne de fax |
| FaxLineApi | ListeLigneFax | OBTENIR /fax_line/list | Liste des lignes de fax |
| FaxLineApi | FaxLineSupprimerutilisateur | PUT /fax_line/remove_user | Supprimer l'accès à la ligne de fax |
| OAuthApi | OauthTokenGénérer | POST /oauth/jeton | Générer un jeton OAuth |
| OAuthApi | OauthTokenActualiser | POST /oauth/token?actualiser | Actualisation du jeton OAuth |
| API de rapport | RapportCréer | POST /rapport/créer | Créer un rapport |
| SignatureRequestApi | SignatureRequestBulkCreateEmbeddedWithTemplate | POST /signature_request/bulk_create_embedded_with_template | Envoi groupé intégré avec modèle |
| SignatureRequestApi | SignatureRequestBulkSendWithTemplate | POST /signature_request/bulk_send_with_template | Envoi groupé avec modèle |
| SignatureRequestApi | SignatureDemandeAnnuler | POST /signature_request/cancel/{signature_request_id} | Annuler la demande de signature incomplète |
| SignatureRequestApi | SignatureRequestCreateEmbedded | POST /signature_request/create_embedded | Créer une demande de signature intégrée |
| SignatureRequestApi | SignatureRequestCreateEmbeddedWithTemplate | POST /signature_request/create_embedded_with_template | Créer une demande de signature intégrée avec un modèle |
| SignatureRequestApi | Fichiers de demande de signature | OBTENIR /signature_request/files/{signature_request_id} | Télécharger des fichiers |
| SignatureRequestApi | SignatureRequestFilesAsDataUri | OBTENIR /signature_request/files_as_data_uri/{signature_request_id} | Télécharger des fichiers en tant qu'URI de données |
| SignatureRequestApi | SignatureRequestFilesAsFileUrl | OBTENIR /signature_request/files_as_file_url/{signature_request_id} | Télécharger des fichiers en tant qu'URL de fichier |
| SignatureRequestApi | SignatureDemandeObtenir | OBTENIR /signature_request/{signature_request_id} | Obtenir une demande de signature |
| SignatureRequestApi | Liste de demandes de signature | GET /signature_request/list | Répertorier les demandes de signature |
| SignatureRequestApi | SignatureRequestReleaseHold | POST /signature_request/release_hold/{signature_request_id} | Demande de signature de libération en attente |
| SignatureRequestApi | SignatureDemandeRappel | POST /signature_request/remind/{signature_request_id} | Envoyer un rappel de demande |
| SignatureRequestApi | SignatureDemandeSupprimer | POST /signature_request/remove/{signature_request_id} | Supprimer l'accès à la demande de signature |
| SignatureRequestApi | SignatureDemandeEnvoyer | POST /signature_request/envoyer | Envoyer une demande de signature |
| SignatureRequestApi | SignatureRequestSendWithTemplate | POST /signature_request/send_with_template | Envoyer avec modèle |
| SignatureRequestApi | SignatureRequestUpdate | POST /signature_request/update/{signature_request_id} | Mettre à jour la demande de signature |
| ÉquipeApi | TeamAddMember | PUT /équipe/add_member | Ajouter un utilisateur à l'équipe |
| ÉquipeApi | ÉquipeCréer | POST /équipe/créer | Créer une équipe |
| ÉquipeApi | ÉquipeSupprimer | SUPPRIMER /équipe/détruire | Supprimer l'équipe |
| ÉquipeApi | ÉquipeObtenir | OBTENIR /équipe | Obtenez une équipe |
| ÉquipeApi | Info équipe | OBTENIR /équipe/info | Obtenir des informations sur l'équipe |
| ÉquipeApi | Invitations d'équipe | OBTENIR /équipe/invitations | Répertorier les invitations d'équipe |
| ÉquipeApi | Membres de l'équipe | OBTENIR /équipe/membres/{team_id} | Répertorier les membres de l'équipe |
| ÉquipeApi | ÉquipeSupprimerMembre | POST /équipe/remove_member | Supprimer un utilisateur de l'équipe |
| ÉquipeApi | ÉquipeSous-équipes | OBTENIR /team/sub_teams/{team_id} | Liste des sous-équipes |
| ÉquipeApi | Mise à jour de l'équipe | METTRE /équipe | Équipe de mise à jour |
| ModèleApi | ModèleAjouterUtilisateur | POST /template/add_user/{template_id} | Ajouter un utilisateur au modèle |
| ModèleApi | ModèleCréer | POST /modèle/créer | Créer un modèle |
| ModèleApi | ModèleCréerEmbeddedDraft | POST /template/create_embedded_draft | Créer un brouillon de modèle intégré |
| ModèleApi | ModèleSupprimer | POST /template/delete/{template_id} | Supprimer le modèle |
| ModèleApi | Fichiers modèles | OBTENIR /template/files/{template_id} | Obtenir des fichiers modèles |
| ModèleApi | TemplateFilesAsDataUri | OBTENIR /template/files_as_data_uri/{template_id} | Obtenir des fichiers modèles en tant qu'URI de données |
| ModèleApi | ModèleFichiersAsFileUrl | OBTENIR /template/files_as_file_url/{template_id} | Obtenir des fichiers de modèle en tant qu'URL de fichier |
| ModèleApi | ModèleObtenir | OBTENIR /template/{template_id} | Obtenir un modèle |
| ModèleApi | Liste des modèles | OBTENIR /modèle/liste | Modèles de liste |
| ModèleApi | ModèleSupprimerUtilisateur | POST /template/remove_user/{template_id} | Supprimer l'utilisateur du modèle |
| ModèleApi | Fichiers de mise à jour de modèles | POST /template/update_files/{template_id} | Mettre à jour les fichiers de modèle |
| UnclaimedDraftApi | Non réclaméBrouillonCréer | POST /unclaimed_draft/create | Créer un brouillon non réclamé |
| UnclaimedDraftApi | Non réclaméBrouillonCréerEmbedded | POST /unclaimed_draft/create_embedded | Créer un brouillon intégré non réclamé |
| UnclaimedDraftApi | Non réclaméDraftCreateEmbeddedWithTemplate | POST /unclaimed_draft/create_embedded_with_template | Créer un brouillon intégré non réclamé avec un modèle |
| UnclaimedDraftApi | Non réclaméBrouillonModifierEtRenvoyer | POST /unclaimed_draft/edit_and_resend/{signature_request_id} | Modifier et renvoyer le brouillon non réclamé |
Schémas d'authentification définis pour l'API :
