Skip to content

SignRequest/signrequest-csharp-client

Repository files navigation

SignRequest - the C# library for SignRequest.com

NuGet version

Frameworks supported

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

Dependencies

  • FubarCoder.RestSharp.Portable.Core >=4.0.7
  • FubarCoder.RestSharp.Portable.HttpClient >=4.0.7
  • Newtonsoft.Json >=10.0.3

Installation

NuGet

The SignRequest API client can be installed using NuGet with the package name SignRequest.

API Documentation

Full API documentation, including code samples, can be found here: https://signrequest.com/api/v1/docs/

Getting Started

using System;
using System.Diagnostics;
using SignRequest.Api;
using SignRequest.Client;
using SignRequest.Model;

namespace Example
{
    public class DocumentsCreateExample
    {
        public void main()
        {
            // Configure API key authorization: Token
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            Configuration.Default.AddApiKeyPrefix("Authorization", "Token");

            var apiInstance = new DocumentsApi();
            var data = new Document();
            data.FileFromUrl = "https://docs.google.com/document/d/1oI2R1SxfMNZXiz3jCQvorpoklF9xq_dCJnOpkI-zo80/edit?usp=sharing";

            try
            {
                Document result = apiInstance.DocumentsCreate(data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DocumentsApi.DocumentsCreate: " + e.Message );
            }
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://signrequest.com/api/v1

Class Method HTTP request Description
ApiTokensApi ApiTokensList GET /api-tokens/ Retrieve a list of API tokens
DocumentAttachmentsApi DocumentAttachmentsCreate POST /document-attachments/ Create a Document Attachment
DocumentAttachmentsApi DocumentAttachmentsList GET /document-attachments/ Retrieve a list of Document Attachments
DocumentAttachmentsApi DocumentAttachmentsRead GET /document-attachments/{uuid}/ Retrieve a Document Attachment
DocumentsApi DocumentsCreate POST /documents/ Create a Document
DocumentsApi DocumentsDelete DELETE /documents/{uuid}/ Delete a Document
DocumentsApi DocumentsList GET /documents/ Retrieve a list of Documents
DocumentsApi DocumentsRead GET /documents/{uuid}/ Retrieve a Document
DocumentsSearchApi DocumentsSearchList GET /documents-search/ Search documents
EventsApi EventsList GET /events/ Retrieve a list of Events
EventsApi EventsRead GET /events/{id}/ Retrieve an Event
SignrequestQuickCreateApi SignrequestQuickCreateCreate POST /signrequest-quick-create/ Quick create a SignRequest
SignrequestsApi SignrequestsCancelSignrequest POST /signrequests/{uuid}/cancel_signrequest/ Cancel a SignRequest
SignrequestsApi SignrequestsCreate POST /signrequests/ Create a SignRequest
SignrequestsApi SignrequestsList GET /signrequests/ Retrieve a list of SignRequests
SignrequestsApi SignrequestsRead GET /signrequests/{uuid}/ Retrieve a SignRequest
SignrequestsApi SignrequestsResendSignrequestEmail POST /signrequests/{uuid}/resend_signrequest_email/ Resend a SignRequest
TeamMembersApi TeamMembersList GET /team-members/ Retrieve a list of Team Members
TeamMembersApi TeamMembersRead GET /team-members/{uuid}/ Retrieve a Team Member
TeamsApi TeamsCreate POST /teams/ Create a Team
TeamsApi TeamsDelete DELETE /teams/{subdomain}/ Delete a Team
TeamsApi TeamsInviteMember POST /teams/{subdomain}/invite_member/ Invite a Team Member
TeamsApi TeamsList GET /teams/ Retrieve a list of Teams
TeamsApi TeamsPartialUpdate PATCH /teams/{subdomain}/ Update a Team
TeamsApi TeamsRead GET /teams/{subdomain}/ Retrieve a Team
TemplatesApi TemplatesList GET /templates/ Retrieve a list of Templates
TemplatesApi TemplatesRead GET /templates/{uuid}/ Retrieve a Template
WebhooksApi WebhooksCreate POST /webhooks/ Create a Webhook
WebhooksApi WebhooksDelete DELETE /webhooks/{uuid}/ Delete a Webhook
WebhooksApi WebhooksList GET /webhooks/ Retrieve a list of Webhooks
WebhooksApi WebhooksPartialUpdate PATCH /webhooks/{uuid}/ Partially update a Webhook
WebhooksApi WebhooksRead GET /webhooks/{uuid}/ Retrieve a Webhook
WebhooksApi WebhooksUpdate PUT /webhooks/{uuid}/ Update a Webhook

Documentation for Models

Documentation for Authorization

Token

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header