net sdk

======================= не используйте главную филиал

Signaturit Net SDK

Этот пакет представляет собой чистую обертку вокруг API 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 Access.

 string accessToken = "OTllYjUwM2NhYmNjNmJlYTZlNWEzNWYzYmZjNTRiZWI2YjU0ZjUxNzUwZDRjZjEwZTA0ZTFkZWQwZGExNDM3ZQ" ;

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

Обратите внимание, что по умолчанию клиент будет использовать наш API 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" )

Получить документ Audit Trail

Получите документ Audit Trail о запросе по электронной почте.

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