net sdk

======================== Vous n'utilisez pas la branche maîtresse

Signaturit net SDK

Ce package est un emballage net autour de l'API Signaturit. Si vous n'avez pas encore lu la documentation, il est peut-être temps de jeter un œil ici.

Test

Afin d'exécuter la suite de tests:

 dotnet test /p:CollectCoverage=true /p:CoverletOutputFormat="opencover"

Pour télécharger les informations sur Sonarqube:

 dotnet tool install --global dotnet-sonarscanner --version 4.7.1

dotnet sonarscanner begin /o:"signaturit" /k:signaturit_net-sdk /d:sonar.host.url="https://sonarcloud.io" /d:sonar.login="YOUR_TOKEN" /s:"$(PWD)/SonarQube.Analysis.xml"

dotnet build

dotnet test /p:CollectCoverage=true /p:CoverletOutputFormat="opencover"

dotnet sonarscanner end /d:sonar.login="YOUR_TOKEN"

Configuration

La façon recommandée d'installer le SDK est via Project.json.

 " dependencies " : {
    " signaturit " : " 1.0.0 "
}

Instanciez ensuite la classe client transmettant votre jeton d'accès API.

 string accessToken = "OTllYjUwM2NhYmNjNmJlYTZlNWEzNWYzYmZjNTRiZWI2YjU0ZjUxNzUwZDRjZjEwZTA0ZTFkZWQwZGExNDM3ZQ" ;

Signaturit . Client client = new Signaturit . Client ( accessToken ) ;

Veuillez noter que par défaut, le client utilisera notre API Sandbox. Lorsque vous êtes prêt à commencer à utiliser l'environnement de production, obtenez le bon jeton d'accès et transmettez un argument supplémentaire au constructeur:

 Signaturit . Client client = new Signaturit . Client ( accessToken , true ) ; 

Exemples

Signatures

Compter les demandes de signature

Comptez vos demandes de signature.

 object response = client . countSignatures ( ) ;

Obtenez toutes les demandes de signature

Récupérez toutes les données de vos demandes de signature à l'aide de différents filtres.

Toutes les signatures

 object response = client . getSignatures ( ) ; 

Obtenir les 50 dernières signatures

 object response = client . getSignatures ( 50 ) ; 

Obtenir des signatures avec un champ personnalisé "CRM_ID"

 object response = client . getSignatures ( 100 , 0 , new { crm_id = "CUSTOM_ID" } )

Obtenez une demande de signature

Obtenez les informations concernant une demande de signature unique passant son identifiant.

 object response = client . getSignature ( "a066298d-2877-11e4-b641-080027ea3a6e" ) ;

Demande de signature

Créer une nouvelle demande de signature.

 object files = new [ ] {
    "./documents/contracts/receipt250.pdf"
} ;

object recipients = new [ ] {
    new { name = "Mr John" , email = "[email protected]" }
} ;

object parameters = new {
    subject = "Receipt no. 250" ,
    body = "Please sign the receipt"
} ;

object response = client . createSignature ( files , recipients , parameters ) ;

Vous pouvez ajouter des informations personnalisées dans vos demandes

 object files = new [ ] {
    "./documents/contracts/receipt250.pdf"
} ;

object recipients = new [ ] {
    new { name = "Mr John" , email = "[email protected]" }
} ;

object parameters = new {
    subject = "Receipt no. 250" ,
    body = "Please sign the receipt" ,
    data = new {
        crm_id = "45673"
    }
} ;

object response = client . createSignature ( files , recipients , parameters ) ;

Vous pouvez envoyer des modèles avec les champs remplis

 object recipients = new [ ] {
    new { name = "Mr John" , email = "[email protected]" }
} ;

object parameters = new {
    subject = "Receipt no. 250" ,
    body = "Please sign the receipt" ,
    templates = "template_name" ,
    data = new {
        widget_id = "default value"
    }
} ;

object response = client . createSignature ( files , recipients , parameters ) ;

Annuler la demande de signature

Annuler une demande de signature.

 object response = client . cancelSignature ( "a066298d-2877-11e4-b641-080027ea3a6e" ) ;

Envoyer un rappel

Envoyez un e-mail de rappel.

 object response = client . sendReminder ( "a066298d-2877-11e4-b641-080027ea3a6e" ) ;

Obtenez une piste d'audit

Obtenez la piste d'audit d'un document de demande de signature

 string response = client . downloadAuditTrail ( "a066298d-2877-11e4-b641-080027ea3a6e" , "d474a1eb-2877-11e4-b641-080027ea3a6e" ) ;

Obtenir un document signé

Obtenez le document signé d'un document de demande de signature

 string response = client . downloadSignedDocument ( "a066298d-2877-11e4-b641-080027ea3a6e" , "d474a1eb-2877-11e4-b641-080027ea3a6e" ) ; 

Marque

Obtenir des marques

Obtenez toutes les marques de compte.

 object response = client . getBrandings ( ) ;

Obtenir la marque

Obtenez une seule marque.

 object response = client . getBranding ( "6472aad7-2877-11e4-b641-080027ea3a6e" ) ;

Créer une marque

Créez une nouvelle marque.

 object parameters = new {
    layout_color      = "#FFBF00" ,
    text_color        = "#2A1B0A" ,
    application_texts = new { sign_button = "Sign!" }
} ;

object response = client . createBranding ( parameters ) ;

Mettre à jour la marque

Mettez à jour une seule marque.

 object parameters = new {
    application_texts = new { send_button = "Send!" }
} ;

object response = client . updateBranding ( "6472aad7-2877-11e4-b641-080027ea3a6e" , parameters ) ; 

Modèle

Obtenez tous les modèles

Récupérez toutes les données de vos modèles.

 object response = client . getTemplates ( ) ; 

E-mail

Recevoir des e-mails

#### Recevez tous les e-mails certifiés

 object response = client . getEmails ( )

#### recevoir les 50 derniers e-mails

 object response = client . getEmails ( 50 )

#### naviguer dans tous les e-mails en blocs de 50 résultats

 object response = client . getEmails ( 50 , 50 )

Compter les e-mails

Comptez tous les e-mails certifiés

 object response = client . countEmails ( )

Recevoir un e-mail

Recevoir un seul e-mail

 object response = client . getEmail ( "EMAIL_ID" )

Créer un e-mail

Créez un nouvel e-mail certifié.

 object files = new [ ] {
    "./demo.pdf" ,
    "./receipt.pdf"
} ;

object recipients = new [ ] {
    new { name = "Mr John" , email = "[email protected]" }
} ;

object parameters = new {
    subject = "NET subject" ,
    body = "NET body"
} ;

object response = client . createEmail ( files , recipients , "NET subject" , "NET body" )

Obtenez un document de piste d'audit

Obtenez le document de la piste d'audit d'une demande par e-mail.

 string response = client . downloadEmailAuditTrail ( "EMAIL_ID" , "CERTIFICATE_ID" )