net sdk

========================= No use la rama maestra

SDK NET de Signaturit

Este paquete es un envoltorio neto alrededor de la API de significado. Si aún no leyó la documentación, tal vez sea hora de echar un vistazo aquí.

Prueba

Para ejecutar la suite de prueba:

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

Para cargar la información a 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"

Configuración

La forma recomendada de instalar el SDK es a través de Project.json.

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

Luego instancie la clase de cliente que pasa en su token de acceso API.

 string accessToken = "OTllYjUwM2NhYmNjNmJlYTZlNWEzNWYzYmZjNTRiZWI2YjU0ZjUxNzUwZDRjZjEwZTA0ZTFkZWQwZGExNDM3ZQ" ;

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

Tenga en cuenta que de manera predeterminada el cliente usará nuestra API Sandbox. Cuando esté listo para comenzar a usar el entorno de producción, simplemente obtenga el token de acceso correcto y pase un argumento adicional al constructor:

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

Ejemplos

Firmas

Contar solicitudes de firma

Cuente sus solicitudes de firma.

 object response = client . countSignatures ( ) ;

Obtenga todas las solicitudes de firma

Recupere todos los datos de sus solicitudes de firma utilizando diferentes filtros.

Todas las firmas

 object response = client . getSignatures ( ) ; 

Obtener las últimas 50 firmas

 object response = client . getSignatures ( 50 ) ; 

Obtener firmas con campo personalizado "CRM_ID"

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

Obtener solicitud de firma

Obtenga la información sobre una sola solicitud de firma que pase su identificación.

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

Solicitud de firma

Cree una nueva solicitud de firma.

 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 ) ;

Puede agregar información personalizada en sus solicitudes

 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 ) ;

Puede enviar plantillas con los campos llenos

 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 ) ;

Cancelar la solicitud de firma

Cancelar una solicitud de firma.

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

Enviar recordatorio

Envíe un correo electrónico de recordatorio.

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

Obtener pista de auditoría

Obtenga la ruta de auditoría de un documento de solicitud de firma

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

Obtenga el documento firmado

Obtenga el documento firmado de un documento de solicitud de firma

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

Herrada

Obtener marcas

Obtenga todas las marcas de cuenta.

 object response = client . getBrandings ( ) ;

Obtener marca

Obtenga una sola marca.

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

Crear marca

Crear una nueva marca.

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

object response = client . createBranding ( parameters ) ;

Actualizar la marca

Actualizar una sola marca.

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

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

Plantilla

Obtener todas las plantillas

Recupere todos los datos de sus plantillas.

 object response = client . getTemplates ( ) ; 

Correo electrónico

Obtener correos electrónicos

#### Obtenga todos los correos electrónicos certificados

 object response = client . getEmails ( )

#### Obtenga los últimos 50 correos electrónicos

 object response = client . getEmails ( 50 )

#### Navegue a través de todos los correos electrónicos en bloques de 50 resultados

 object response = client . getEmails ( 50 , 50 )

Contar correos electrónicos

Cuente todos los correos electrónicos certificados

 object response = client . countEmails ( )

Recibir correo electrónico

Obtenga un solo correo electrónico

 object response = client . getEmail ( "EMAIL_ID" )

Crear correo electrónico

Cree un nuevo correo electrónico certificado.

 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" )

Obtener documento de senderos de auditoría

Obtenga el documento de la pista de auditoría de una solicitud de correo electrónico.

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