If you are citizen of an European Union member nation, you may not use this service unless you are at least 16 years old.
You already know Dokkio is an AI-powered assistant to organize & manage your digital files & messages. Very soon, Dokkio will support Outlook as well as One Drive. Check it out today!

FrontPage

Page history last edited by Jonathan Siegel 14 years, 8 months ago

Welcome to the RightSignature API Wiki.

API Documentation

Getting Started
Register for your API credentials at https://RightSignature.com/oauth_clients/new. We will review and approve your request within 1 business day--or we will contact you with specific questions. When your application is approved, you will receive a link to your oauth client management page.

3. Using the consumer key/secret supplied, you will be able to build a standard OAuth handshake process to request authorization to access an individual user account on RightSignature--this provides you with an access token and access key/secret credentials. This is well described in the OAuth standard. Alternatively you can request an access key/secret for your own account (see OAuth Shortcut below).

4. Finally, using one of the OAuth libraries for your language and platform, you use the client application key/secret and user access key/secret to make requests on a user's behalf to our REST API portal at https://RightSignature.com/api.

5. Currently we expose only one resource, the document model, which can be queried for a list of user documents and their associate states. Additionally a new document can be created with a simple post request. See details for the Document API below.

Document Resource URLs

[GET] https://RightSignature.com/api/documents.[xml,json] -- returns a list of user's documents in XML or JSON format. Note that this is a great URL to hit from within your browser while logged into RightSignature to get an idea of the API return data.
[GET] https://RightSignature.com/api/documents/{document reference number}.[xml,json] -- returns detailed information on a particular document.
[POST] https://RightSignature.com/api/documents.[xml,json] -- creates a document based on the contents of the posted data. Returns the document reference number.

Creating a new Document

You may create a new RightSignature document for a target account by making an OAuth authenticated request to https://RightSignature.com/api/documents.xml with a post parameter named 'xml' containing:

<document>
<recipients> 
<recipient><self>true</self><role>cc</role><!-- ignores email/name when self found... --></recipient>
<recipient><role>cc</role><email>support@rightsignature.com</email><name>API Test Create</name></recipient>
<recipient><role>signer</role><email>support1@rightsignature.com</email><name>API Test Create</name></recipient>
<recipient><role>signer</role><email>support2@rightsignature.com</email><name>API Test Create</name></recipient>
<recipient><role>signer</role><email>support3@rightsignature.com</email><name>API Test Create</name></recipient>
</recipients>
<expires-in>30 days</expires-in>
<subject>The subject</subject>
<message>The message</message>
<assets><asset><location>#{CGI.escapeHTML(location)}</location></asset></assets>
<callback_location>#{CGI.escapeHTML(location_callback)}</callback_location>
</document>

The callback location is a location on your site that accepts GET requests from our server in the form:
- callback_url?status=XXX&document_reference=XXX

Listing Documents

Placing a GET request to https://RightSignature.com/api/documents.xml or https://RightSignature.com/api/documents.json returns a list of all of the documents available under the user account. A JSON reply might look like:

[{"document": 
{
"state": "signed-notarized", 
"sharing_tools": false, 
"pdf_url": "https://xxx.com:443/XXNV.pdf?Signature=1XSgeuwCXXU%3D", 
"original_filename": "filename.pdf", 
"message": "Please sign this document.", 
"deleted_at": null, 
"created_at": "2009-08-06T06:49:58-07:00", 
"thumbnail_url": "URL.png", 
"is_public": false, 
"unsanitized_original_filename": "filename.pdf", 
"callback_location": null, 
"location": null, 
"filename": null, 
"size": 158720, 
"expires_on": "2009-09-05T17:00:00-07:00", 
"notarized_pdf_url": "URL-signed.pdf?Signature=SSCYSG2", 
"is_signed": true, 
"requires_individual_copies": false, 
"subject": "Test Document", 
"original_url": "URL", 
"content_type": "pdf", 
"completed_at": "2009-08-06T06:52:20-07:00", 
"updated_at": "2009-08-06T06:52:20-07:00", 
"guid": "XXX"}}, ...]

Within this reply you can quickly check the status of the document (state) and retrieve the final signed document package (notarized_pdf_url--which is a temporary link valid for 1 day).

OAuth

OAuth FAQ Twitter's great OAuth FAQ...
OAuth Examples Twitter's examples... we'll have our own shortly.

OAuth Shortcut

For 3rd party integration where you'd like a user access key/secret for your own account, you may authorize and generate an access token without writing external handshake code yourself. We allow you to quickly generate a user access key/secret within the OAuth client management area of our site. This saves you the time to write a handshake routine just to get credentials to access your own account. If you navigate to our site and go to your account => API Access => manage API access to your account => under "Application Developers" -- select your approved API registration => then select the link "Request an authorized access token". When this is selected, we will generate an access token and provide its credentials for your immediate usage.