net sdk
1.0.0
このパッケージは、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 ( ) ; object response = client . getSignatures ( 50 ) ; 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 ( )1つのメールを取得します
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" )
