SignRequest API Client

API for SignRequest.com

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

pip install signrequest-python-client

(you may need to run pip with root permission: sudo pip install signrequest_python_client)

Then import the package:

import signrequest_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import signrequest_client

API Documentation

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

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import signrequest_client
from signrequest_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Token
default_configuration = signrequest_client.Configuration()
default_configuration.api_key['Authorization'] = 'YOUR_API_KEY'
default_configuration.api_key_prefix['Authorization'] = 'Token'
signrequest_client.Configuration.set_default(default_configuration)

# create an instance of the API class
api_instance = signrequest_client.DocumentsApi()
data = signrequest_client.Document(
    file_from_url='https://docs.google.com/document/d/1oI2R1SxfMNZXiz3jCQvorpoklF9xq_dCJnOpkI-zo80/edit?usp=sharing'
)


try:
    # Create a Document
    api_response = api_instance.documents_create(data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentsApi->documents_create: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
ApiTokensApi	api_tokens_list	GET /api-tokens/	Retrieve a list of API tokens
DocumentAttachmentsApi	document_attachments_create	POST /document-attachments/	Create a Document Attachment
DocumentAttachmentsApi	document_attachments_list	GET /document-attachments/	Retrieve a list of Document Attachments
DocumentAttachmentsApi	document_attachments_read	GET /document-attachments/{uuid}/	Retrieve a Document Attachment
DocumentsApi	documents_create	POST /documents/	Create a Document
DocumentsApi	documents_delete	DELETE /documents/{uuid}/	Delete a Document
DocumentsApi	documents_list	GET /documents/	Retrieve a list of Documents
DocumentsApi	documents_read	GET /documents/{uuid}/	Retrieve a Document
DocumentsSearchApi	documents_search_list	GET /documents-search/	Search documents
EventsApi	events_list	GET /events/	Retrieve a list of Events
EventsApi	events_read	GET /events/{id}/	Retrieve an Event
SignrequestQuickCreateApi	signrequest_quick_create_create	POST /signrequest-quick-create/	Quick create a SignRequest
SignrequestsApi	signrequests_cancel_signrequest	POST /signrequests/{uuid}/cancel_signrequest/	Cancel a SignRequest
SignrequestsApi	signrequests_create	POST /signrequests/	Create a SignRequest
SignrequestsApi	signrequests_list	GET /signrequests/	Retrieve a list of SignRequests
SignrequestsApi	signrequests_read	GET /signrequests/{uuid}/	Retrieve a SignRequest
SignrequestsApi	signrequests_resend_signrequest_email	POST /signrequests/{uuid}/resend_signrequest_email/	Resend a SignRequest
TeamMembersApi	team_members_list	GET /team-members/	Retrieve a list of Team Members
TeamMembersApi	team_members_read	GET /team-members/{uuid}/	Retrieve a Team Member
TeamsApi	teams_create	POST /teams/	Create a Team
TeamsApi	teams_delete	DELETE /teams/{subdomain}/	Delete a Team
TeamsApi	teams_invite_member	POST /teams/{subdomain}/invite_member/	Invite a Team Member
TeamsApi	teams_list	GET /teams/	Retrieve a list of Teams
TeamsApi	teams_partial_update	PATCH /teams/{subdomain}/	Update a Team
TeamsApi	teams_read	GET /teams/{subdomain}/	Retrieve a Team
TemplatesApi	templates_list	GET /templates/	Retrieve a list of Templates
TemplatesApi	templates_read	GET /templates/{uuid}/	Retrieve a Template
WebhooksApi	webhooks_create	POST /webhooks/	Create a Webhook
WebhooksApi	webhooks_delete	DELETE /webhooks/{uuid}/	Delete a Webhook
WebhooksApi	webhooks_list	GET /webhooks/	Retrieve a list of Webhooks
WebhooksApi	webhooks_partial_update	PATCH /webhooks/{uuid}/	Partially update a Webhook
WebhooksApi	webhooks_read	GET /webhooks/{uuid}/	Retrieve a Webhook
WebhooksApi	webhooks_update	PUT /webhooks/{uuid}/	Update a Webhook

Documentation For Models

• AuthToken
• Document
• DocumentAttachment
• DocumentSearch
• DocumentSignerTemplateConf
• DocumentSigningLog
• DocumentSignrequest
• DocumentTeam
• Event
• FileFromSf
• InlineDocumentSignerIntegrationData
• InlineIntegrationData
• InlinePrefillTags
• InlineResponse200
• InlineResponse2001
• InlineResponse2002
• InlineResponse2003
• InlineResponse2004
• InlineResponse2005
• InlineResponse2006
• InlineResponse2007
• InlineResponse2008
• InlineResponse2009
• InlineResponse201
• InlineResponse2011
• InlineSignRequest
• InlineTeam
• InlineTeamMember
• InviteMember
• Placeholder
• RequiredAttachment
• SignRequest
• SignRequestQuickCreate
• Signer
• SignerAttachment
• SignerInputs
• SigningLog
• Team
• TeamMember
• Template
• User
• WebhookSubscription

Documentation For Authorization

Token

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

Author

tech-support@signrequest.com