net sdk

======================== JANGAN Gunakan Cabang Master

Signaturit Net SDK

Paket ini adalah pembungkus bersih di sekitar API Signaturit. Jika Anda belum membaca dokumentasinya, mungkin sudah waktunya untuk melihatnya di sini.

Tes

Untuk menjalankan suite tes:

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

Untuk mengunggah informasi ke 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"

Konfigurasi

Cara yang disarankan untuk menginstal SDK adalah melalui Project.json.

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

Kemudian instantiate kelas klien yang melewati token akses API Anda.

 string accessToken = "OTllYjUwM2NhYmNjNmJlYTZlNWEzNWYzYmZjNTRiZWI2YjU0ZjUxNzUwZDRjZjEwZTA0ZTFkZWQwZGExNDM3ZQ" ;

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

Harap dicatat bahwa secara default klien akan menggunakan API Sandbox kami. Ketika Anda siap untuk mulai menggunakan lingkungan produksi, hanya mendapatkan token akses yang benar dan memberikan argumen tambahan kepada konstruktor:

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

Contoh

Tanda tangan

Hitung permintaan tanda tangan

Hitung permintaan tanda tangan Anda.

 object response = client . countSignatures ( ) ;

Dapatkan semua permintaan tanda tangan

Ambil semua data dari permintaan tanda tangan Anda menggunakan filter yang berbeda.

Semua tanda tangan

 object response = client . getSignatures ( ) ; 

Mendapatkan 50 tanda tangan terakhir

 object response = client . getSignatures ( 50 ) ; 

Mendapatkan tanda tangan dengan bidang khusus "CRM_ID"

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

Dapatkan permintaan tanda tangan

Dapatkan informasi mengenai satu permintaan tanda tangan yang melewati ID -nya.

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

Permintaan tanda tangan

Buat permintaan tanda tangan baru.

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

Anda dapat menambahkan info khusus dalam permintaan Anda

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

Anda dapat mengirim templat dengan bidang yang diisi

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

Batalkan permintaan tanda tangan

Batalkan permintaan tanda tangan.

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

Kirim Pengingat

Kirim email pengingat.

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

Dapatkan Jejak Audit

Dapatkan jejak audit dari dokumen permintaan tanda tangan

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

Dapatkan dokumen yang ditandatangani

Dapatkan dokumen yang ditandatangani dari dokumen permintaan tanda tangan

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

Branding

Dapatkan Brandings

Dapatkan semua branding akun.

 object response = client . getBrandings ( ) ;

Dapatkan branding

Dapatkan satu branding.

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

Buat branding

Buat branding baru.

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

object response = client . createBranding ( parameters ) ;

Perbarui branding

Perbarui satu branding.

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

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

Templat

Dapatkan semua templat

Ambil semua data dari templat Anda.

 object response = client . getTemplates ( ) ; 

E-mail

Dapatkan email

#### Dapatkan semua email bersertifikat

 object response = client . getEmails ( )

#### Dapatkan 50 email terakhir

 object response = client . getEmails ( 50 )

#### Navigasi melalui semua email dalam blok 50 hasil

 object response = client . getEmails ( 50 , 50 )

Hitung email

Hitung semua email bersertifikat

 object response = client . countEmails ( )

Dapatkan email

Dapatkan satu email

 object response = client . getEmail ( "EMAIL_ID" )

Buat email

Buat email bersertifikat baru.

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

Dapatkan Dokumen Jejak Audit

Dapatkan dokumen Audit Trail dari permintaan email.

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