net sdk

=======================不要使用主分支

Signaturit Net SDK

该软件包是Signaturit API周围的网状包装器。如果您还没有阅读文档，也许是时候在这里看看。

测试

为了执行测试套件：

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

将信息上传到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"

配置

安装SDK的推荐方法是通过project.json。

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

然后实例化在API访问令牌中传递的客户端类。

 string accessToken = "OTllYjUwM2NhYmNjNmJlYTZlNWEzNWYzYmZjNTRiZWI2YjU0ZjUxNzUwZDRjZjEwZTA0ZTFkZWQwZGExNDM3ZQ" ;

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

请注意，默认情况下，客户端将使用我们的沙盒API。当您准备开始使用生产环境时，只需获得正确的访问令牌，然后将附加参数传递给构造函数：

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

例子

签名

计算签名请求

计算您的签名请求。

 object response = client . countSignatures ( ) ;

获取所有签名请求

使用不同的过滤器从签名请求中检索所有数据。

所有签名

 object response = client . getSignatures ( ) ; 

获得最后50个签名

 object response = client . getSignatures ( 50 ) ; 

使用自定义字段“ CRM_ID”获得签名

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

获取签名请求

获取有关通过其ID的单个签名请求的信息。

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

签名请求

创建一个新的签名请求。

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

您可以在请求中添加自定义信息

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

您可以发送填充字段的模板

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

取消签名请求

取消签名请求。

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

发送提醒

发送提醒电子邮件。

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

获取审核步道

获取签名请求文件的审计踪迹

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

获取签名文件

获取签名请求文件的签名文件

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

品牌

获取品牌

获取所有帐户品牌。

 object response = client . getBrandings ( ) ;

获得品牌

获得一个品牌。

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

创建品牌

创建一个新的品牌。

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

object response = client . createBranding ( parameters ) ;

更新品牌

更新单个品牌。

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

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

模板

获取所有模板

从模板中检索所有数据。

 object response = client . getTemplates ( ) ; 

电子邮件

获取电子邮件

####获取所有经过认证的电子邮件

 object response = client . getEmails ( )

####获取最后50封电子邮件

 object response = client . getEmails ( 50 )

####浏览50个结果的所有电子邮件

 object response = client . getEmails ( 50 , 50 )

计数电子邮件

计算所有经过认证的电子邮件

 object response = client . countEmails ( )

获取电子邮件

收到一封电子邮件

 object response = client . getEmail ( "EMAIL_ID" )

创建电子邮件

创建新的认证电子邮件。

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

获取审核步道文件

获取电子邮件请求的审计跟踪文件。

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