Com.Zynyo.SigningService 1.0.1

README

Com.Zynyo.SigningService - the C# library for the ZYNYO Signing Service REST API

The Zynyo Signing Service allows you to submit PDF documents to be signed by one or multiple signatories, query the current documents, cancel a document, send reminders to signatories and retrieve the signed PDF document after the signing authenticationMethod is complete.

The service supports multiple authenticating methods for signatories. A detailed explanation of the supported authentication methods can be found in the developers documentation.

This documentation is intended for developers who want to incorporate the Signing Service into their own (web) application via this REST API. Getting started is easy: contact info@zynyo.com for a API test key on which you start right away.

The API is based on OpenAPI Specification for RESTful APIs. For more information on OpenAPI, please go to <a href="https://www.openapis.org/">www.openapis.org</a> standards.

For any help, please don't hesitate and contact Zynyo support at <a href="mailto:support@zynyo.com"> support@zynyo.com</a>. We will contact you as soon as possible.

• API version: v3
• SDK version: 1.0.1 For more information, please visit https://zynyo.com

<a name="frameworks-supported"></a>

Frameworks supported

• .NET Core >=1.0
• .NET Framework >=4.6
• Mono/Xamarin >=vNext

<a name="dependencies"></a>

Dependencies

• RestSharp - 106.13.0 up to 108.0.3
• Json.NET - 13.0.2 or later
• JsonSubTypes - 1.8.0 or later
• System.ComponentModel.Annotations - 5.0.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp -Version 108.0.3
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

<a name="installation"></a>

Installation

Use NuGet to obtain the latest version of the package:

Install-Package Com.Zynyo.SigningService

Then use the namespaces:

using Com.Zynyo.SigningService.Api;
using Com.Zynyo.SigningService.Client;
using Com.Zynyo.SigningService.Model;

<a name="usage"></a>

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

<a name="getting-started"></a>

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using Com.Zynyo.SigningService.Api;
using Com.Zynyo.SigningService.Client;
using Com.Zynyo.SigningService.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://signingservice.zynyo.com/api/rest/v3";
            var apiInstance = new DocumentsApi(config);
            var apikey = "apikey_example";  // string | Your Zynyo API key
            var uuid = "uuid_example";  // string | The document uuid

            try
            {
                // Get a single document
                ModelDocument result = apiInstance.GetDocument(apikey, uuid);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling DocumentsApi.GetDocument: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

<a name="documentation-for-api-endpoints"></a>

Documentation for API Endpoints

All URIs are relative to https://signingservice.zynyo.com/api/rest/v3

<a name="documentation-for-models"></a>

Documentation for Models

• Attachment
• AuthenticationMethod
• AuthType
• CSCAuthenticationMethod
• CancelDocumentRequest
• CancelDocumentResponse
• Certificate
• CertificateAuthenticationMethod
• CertificateExpiredResponse
• CertificateResponse
• CheckedIDAuthenticationMethod
• DeliveryAttachment
• DeliveryRequest
• DigiDAuthenticationMethod
• DocumentAnchorAuthenticationMethod
• DocumentCallback
• DocumentFile
• DocumentInfo
• DocumentState
• DocumentStateLog
• DocumentSummary
• DocumentTemplateAuthenticationMethod
• DocumentTemplateCreationRequest
• DocumentTemplateReference
• DocumentTemplateSource
• DocumentTemplateUpdateRequest
• EditDocumentRequest
• EditDocumentResponse
• Email
• EmailState
• EmailStateReport
• IDINAuthenticationMethod
• IRMAAuthenticationMethod
• Locale
• MergeType
• MessageResponse
• ModelAddress
• ModelAuthenticationMethod
• ModelCSCAuthenticationMethod
• ModelCertificateAuthenticationMethod
• ModelCheckedIDAuthenticationMethod
• ModelDigiDAuthenticationMethod
• ModelDocument
• ModelDocumentAnchorAuthenticationMethod
• ModelDocumentGroup
• ModelDocumentTemplate
• ModelDocumentTemplateAuthenticationMethod
• ModelIDINAuthenticationMethod
• ModelIRMAAuthenticationMethod
• ModelMouseSignatureAuthenticationMethod
• ModelSMSTANAuthenticationMethod
• ModelSignRequest
• ModelSignatory
• ModelTemplateLabel
• MouseSignatureAuthenticationMethod
• QuickSignDocumentRequest
• QuickSignDocumentResponse
• Recipient
• RecipientRole
• ReminderRequest
• ReminderResponse
• SMSTANAuthenticationMethod
• SignDocumentRequest
• SignDocumentResponse
• SignHashRequest
• SignHashResponse
• SignMultiDocumentRequest
• SignRequestType
• Signatory
• SignatoryLink
• SignatoryPriority
• SignatoryRole
• SignatoryState
• SignatoryStateLog
• SignatoryStatus
• SignatoryUpdate
• SignatureLabel
• SignedDocumentResponse
• TemplateLabelType
• Usage
• UsageType

<a name="documentation-for-authorization"></a>

Documentation for Authorization

All endpoints use API-key authorization. The API-key should be specified as method parameter.