net sdk

========================= لا تستخدم الفرع الرئيسي

Signaturit Net SDK

هذه الحزمة عبارة عن غلاف صافي حول واجهة برمجة تطبيقات signaturit. إذا لم تقرأ الوثائق بعد ، فربما حان الوقت لإلقاء نظرة هنا.

امتحان

من أجل تنفيذ مجموعة الاختبار:

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

يرجى ملاحظة أنه افتراضيًا ، سيستخدم العميل واجهة برمجة تطبيقات Sandbox. عندما تكون مستعدًا للبدء في استخدام بيئة الإنتاج ، فقط احصل على رمز الوصول الصحيح وتمرير وسيطة إضافية إلى المنشئ:

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

الحصول على طلب توقيع

احصل على المعلومات المتعلقة بطلب توقيع واحد تمرير هويته.

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