Skip to content

legalesign/LegalesignCsharpSDK

BranchesTags

Repository files navigation

Org.OpenAPITools - the C# library for the Legalesign API

Legalesign.com is an electronic signature software. This is the documentation for its C# SDK.

Start by creating a trial account at https://access.legalesign.com/?q=signUp. Upon account activation, select the API dev option.

Get an API key by emailing support@legalesign.com with background on your use-case and skills. You will need to show experience in API dev.

You will start in sandbox mode and limited to 5 signers. Add your test signers on https://app1.legalesign.com/acc/settings/#api. You will also find your API username and secret there.

The format for your API key (referred to as YOUR_API_KEY in the documentation) is: 'ApiKey username:secret'. Contact support to move to production mode when you are ready.

For any queries contact us at support@legalesign.com.

Quickstart article coming very soon.

This C# SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • SDK version: 1.0.0
  • Build package: org.openapitools.codegen.languages.CSharpClientCodegen For more information, please visit https://legalesign.com/contact/

Frameworks supported

  • .NET 4.0 or later
  • Windows Phone 7.1 (Mango)

Dependencies

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
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

Run the following command to generate the DLL

  • [Mac/Linux] /bin/sh build.sh
  • [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out Org.OpenAPITools.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            Configuration.Default.BasePath = "https://eu-api.legalesign.com/api/v1";
            // Configure API key authorization: apikeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AttachmentApi(Configuration.Default);
            var attachmentId = "attachmentId_example";  // Guid | attachment id

            try
            {
                // Delete attachment
                apiInstance.DeleteAttachment(attachmentId);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AttachmentApi.DeleteAttachment: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://eu-api.legalesign.com/api/v1

Class Method HTTP request Description
AttachmentApi DeleteAttachment DELETE /attachment/{attachmentId} Delete attachment
AttachmentApi GetAttachment GET /attachment/{attachmentId} Get attachment
AttachmentApi GetAttachments GET /attachment/ Get attachments
AttachmentApi PostAttachment POST /attachment/ Upload attachment (PDF)
DocumentApi ArchiveDocument DELETE /document/{docId} Void/archive signing document
DocumentApi DeleteDocument DELETE /document/{docId}/delete Permanently delete signing document
DocumentApi GetDocument GET /document/{docId} Get document
DocumentApi GetDocumentFields GET /document/{docId}/fields Get document fields
DocumentApi GetDocumentPdf GET /pdf/{docId} Location to download PDF
DocumentApi GetDocuments GET /document/ Get signing documents
DocumentApi GetStatus GET /status/{docId} Get signing document status
DocumentApi GetStatuses GET /status Get signing documents status
DocumentApi PostDocument POST /document/ Create signing document
DocumentApi PostPdfPreview POST /pdf/preview text/html document as pdf preview
DocumentApi PreviewDocumentSigning POST /document/preview Preview text document signing page
GroupApi GetGroup GET /group/{groupId} Get group
GroupApi GetGroups GET /group Get groups
GroupApi PostGroup POST /group Create group
GroupApi UpdateGroup PATCH /group/{groupId} Update group
MemberApi DeleteInvite DELETE /invited/{invitedId} Delete invitation
MemberApi DeleteMember DELETE /member/{memberId} Remove member from group
MemberApi GetInvites GET /invited Get group invitations
MemberApi GetMember GET /member/{memberId} Get group member
MemberApi GetMembers GET /member Get group members
MemberApi PostMember POST /member Create group member
SignerApi GetSigner GET /signer/{signerId} Get signer
SignerApi GetSignerFields GET /signer/{signerId}/fields1 Get signer form fields
SignerApi GetSignerLink GET /signer/{signerId}/new-link Get signer access link
SignerApi GetSignerRejection GET /signer/{signerId}/rejection Get signer rejection reason
SignerApi PostSignerReminder POST /signer/{signerId}/send-reminder Send signer reminder email
SignerApi PostSignerReset POST /signer/{signerId}/reset Reset to earlier signer
TemplatepdfApi GetPdfTemplate GET /templatepdf/{pdfId} Get PDF template
TemplatepdfApi GetPdfTemplateFields GET /templatepdf/{pdfId}/fields Get PDF template fields
TemplatepdfApi GetPdfTemplates GET /templatepdf Get PDF templates
TemplatepdfApi PostPdfTemplate POST /templatepdf Create PDF template
TemplatepdfApi PostPdfTemplateFields POST /templatepdf/{pdfId}/fields Create PDF template fields
TemplatepdfApi PostPdfTemplateTags POST /templatepdf/{pdfId}/tags Convert text tags
TemplatetextApi ArchiveTextTemplate DELETE /template/{templateId} Archive text template
TemplatetextApi GetTextTemplate GET /template/{templateId} Get text template
TemplatetextApi GetTextTemplates GET /template Get text templates
TemplatetextApi PatchTextTemplate PATCH /template/{templateId} Update text template
TemplatetextApi PostTextTemplate POST /template Create text template
UserApi GetUser GET /user/{userId} Get user
UserApi PatchUser PATCH /user/{userId} Update user
UserApi PostUser POST /user Create user
WebhookApi DeleteWebhook POST /unsubscribe Delete webhook
WebhookApi GetWebhooks GET /notifications Get webhooks
WebhookApi PostWebhook POST /subscribe Create webhook

Documentation for Models

Documentation for Authorization

apikeyAuth

  • Type: API key

  • API key parameter name: Authorization

  • Location: HTTP header

About

OpenAPI CSharp SDK with Winform examples.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages