net sdk

======================== Não use o Master Branch

Signaturit net sdk

Este pacote é um invólucro na rede em torno da API Signaturit. Se você ainda não leu a documentação, talvez seja hora de dar uma olhada aqui.

Teste

Para executar o conjunto de testes:

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

Para fazer upload das informações para 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"

Configuração

A maneira recomendada de instalar o SDK é através do Project.json.

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

Em seguida, instancie a classe do cliente que passa em seu token de acesso à API.

 string accessToken = "OTllYjUwM2NhYmNjNmJlYTZlNWEzNWYzYmZjNTRiZWI2YjU0ZjUxNzUwZDRjZjEwZTA0ZTFkZWQwZGExNDM3ZQ" ;

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

Observe que, por padrão, o cliente usará nossa API de Sandbox. Quando você estiver pronto para começar a usar o ambiente de produção, obtenha o token de acesso correto e passe um argumento adicional ao construtor:

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

Exemplos

Assinaturas

Conte solicitações de assinatura

Conte seus pedidos de assinatura.

 object response = client . countSignatures ( ) ;

Obtenha todos os pedidos de assinatura

Recupere todos os dados de suas solicitações de assinatura usando filtros diferentes.

Todas as assinaturas

 object response = client . getSignatures ( ) ; 

Obtendo as últimas 50 assinaturas

 object response = client . getSignatures ( 50 ) ; 

Obtendo assinaturas com campo personalizado "CRM_ID"

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

Obtenha solicitação de assinatura

Obtenha as informações sobre uma única solicitação de assinatura que aprovava seu ID.

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

Solicitação de assinatura

Crie uma nova solicitação de assinatura.

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

Você pode adicionar informações personalizadas em seus pedidos

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

Você pode enviar modelos com os campos preenchidos

 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 solicitação de assinatura

Cancelar uma solicitação de assinatura.

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

Enviar lembrete

Envie um e -mail de lembrete.

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

Obtenha trilha de auditoria

Obtenha a trilha de auditoria de um documento de solicitação de assinatura

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

Obtenha documento assinado

Obtenha o documento assinado de um documento de solicitação de assinatura

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

Marca

Obtenha marcas

Obtenha todas as marcas de conta.

 object response = client . getBrandings ( ) ;

Obtenha a marca

Obtenha uma única marca.

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

Criar marca

Crie uma nova marca.

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

object response = client . createBranding ( parameters ) ;

Atualize a marca

Atualize uma única marca.

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

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

Modelo

Obtenha todos os modelos

Recuperar todos os dados de seus modelos.

 object response = client . getTemplates ( ) ; 

E-mail

Receba e -mails

#### Obtenha todos os e -mails certificados

 object response = client . getEmails ( )

#### Obtenha os últimos 50 e -mails

 object response = client . getEmails ( 50 )

#### Navegue por todos os e -mails em blocos de 50 resultados

 object response = client . getEmails ( 50 , 50 )

Contam e -mails

Conte todos os e -mails certificados

 object response = client . countEmails ( )

Receba email

Obtenha um único e -mail

 object response = client . getEmail ( "EMAIL_ID" )

Crie email

Crie um novo email 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" )

Obtenha documento de trilha de auditoria

Obtenha o documento da trilha de auditoria de uma solicitação de email.

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