CudaSign

CudaSign REST Service Wrapper

Updates

12/3/2015 - The eval server has been changed to api-eval.cudasign.com. You will need to create a new account for api-eval.cudasign.com. https://eval.cudasign.com.

About CudaSign

CudaSign by Barracuda is an eSigning platform that offers a cloud version, a physical appliance and also a virtual appliance. Backed by Barracuda’s industry-leading security infrastructure, CudaSign is fully compliant with eSigning laws and encrypts all data in transit. Users can share, manage and access their documents with confidence. It’s never been easier to get legally binding signatures from customers, partners, and employees - in seconds using any device.

API Contact Information

If you have questions about the CudaSign API, please visit https://techlib.barracuda.com/CudaSign/RestEndpointsAPI or email api@cudasign.com.

See additional contact information at the bottom.

Installation

$ npm install cudasign

Examples

To run the examples you will need an API key. You can get one here https://cudasign.com/l/api/request_information. For a full list of accepted parameters, refer to the CudaSign REST Endpoints API guide: https://techlib.barracuda.com/CudaSign/RestEndpointsAPI.

Every resource is accessed via your CudaSign instance:

var cudasign = require("cudasign")({
    credentials: "ENCODED_CLIENT_CREDENTIALS",
    production: false //(false uses eval server)
});

Every resource returns two parameters. The first param contains any errors and the second contains the results.

User

Create a User

cudasign.user.create({
    "first_name": "John",
    "last_name": "Wayne",
    "email":"john@domain.com",
    "password":"yourpwd"
}, function(err, res){
    if(!err){
        console.log("RESULTS:" + res);
    }else{
        console.log("ERROR:" + err);
    }
});

Retrieve User Information

cudasign.user.retrieve({token:"your auth token"}, function(err, res){
    if(!err){
        console.log("RESULTS:" + res);
    }else{
        console.log("ERROR:" + err);
    }
}
});

OAuth 2.0

Request Access Token

cudasign.oauth2.requestToken({
    "username": "account username",
    "password": "account password"
}, function(err, res){
    if(!err){
        console.log("RESULTS:" + res);
    }else{
        console.log("ERROR:" + err);
    }
});

Verify an Access Token

cudasign.oauth2.verify({
    token: "your auth token"
}, function(err, res){
    if(!err){
        console.log("RESULTS:" + res);
    }else{
        console.log("ERROR:" + err);
    }
});

Document

Retrieve a List of the User’s Documents

cudasign.document.list({token:"your auth token"}, function(err, res){
    if(!err){
        console.log("RESULTS:" + res);
    }else{
        console.log("ERROR:" + err);
    }
});

Retrieve a Document Resource

cudasign.document.view({
    token: "your auth token",
    id: "document id"
}, function(err, res){
    if(!err){
        console.log("RESULTS:" + res);
    }else{
        console.log("ERROR:" + err);
    }
});

Download a Collapsed Document

cudasign.document.download({
    token: "your auth token",
    id: "document id"
}, function(err, res){
    if(!err){
        console.log("RESULTS:" + res);
    }else{
        console.log("ERROR:" + err);
    }
});

Upload Document

cudasign.document.create({
    token: "your auth token",
    filepath: ""
}, function(err, res){
    if(!err){
        console.log("RESULTS:" + res);
    }else{
        console.log("ERROR:" + err);
    }
});

Upload File & Extract Fields

cudasign.document.fieldextract({
    token: "your auth token",
    filepath: ""
}, function(err, res){
    if(!err){
        console.log("RESULTS:" + res);
    }else{
        console.log("ERROR:" + err);
    }
});

Update Document (add fields)

var fieldsObj = {
    "texts":[
        {
            "size":8,
            "x":61,
            "y":72,
            "page_number":0,
            "font":"Arial",
            "data":"sample text",
            "line_height":9.075
        }
    ]
}
 
cudasign.document.update({
    token: "your auth token",
  id: "document id",
    fields: fieldsObj
}, function(err, res){
    if(!err){
        console.log("RESULTS:" + res);
    }else{
        console.log("ERROR:" + err);
    }
});

Create Invite to Sign a Document

cudasign.document.invite({
    token: "your login token",
    id: "document id",
  data:{
       from: "email address",
        to: "email address"
  }
}, function(err, res){
    if(!err){
        console.log("RESULTS:" + res);
    }else{
        console.log("ERROR:" + err);
    }
});

Cancel an Invite to a Document

cudasign.document.cancelInvite({
    token: "your login token",
    id: "document id"
}, function(err, res){
    if(!err){
        console.log("RESULTS:" + res);
    }else{
        console.log("ERROR:" + err);
    }
});

Create a One-time Use Download URL

cudasign.document.share({
    token: "your login token",
    id: "document id"
}, function(err, res){
    if(!err){
        console.log("RESULTS:" + res);
    }else{
        console.log("ERROR:" + err);
    }
});

Merges Existing Documents

cudasign.document.merge({
    token: "your login token",
    name: "the merged doc",
  document_ids: [
    "84a18d12bf7473ea3dd0e4dd1cdcded6ba6281aa",
    "a71d963c49f33176e90c5827069c422616b1500c"
  ]
}, function(err, res){
    if(!err){
        console.log("RESULTS:" + res);
    }else{
        console.log("ERROR:" + err);
    }
});

Get Document History

cudasign.document.history({
    token: "your login token",
    id: "document id"
}, function(err, res){
    if(!err){
        console.log("RESULTS:" + res);
    }else{
        console.log("ERROR:" + err);
    }
});

Enumerations

Add Enumeration Field to a Document

cudasign.enumerations.addField({
    token: "your login token",
    document_id: "document id",
    "x": 150,
  "y": 200,
  "width": 200,
  "height": 50,
  "page_number": 0,
  "role": "buyer",
  "required": true,
  "label": "Clothing Brand"
}, function(err, res){
    if(!err){
        console.log("RESULTS:" + res);
    }else{
        console.log("ERROR:" + err);
    }
});

Add Enumeration Options to the Field

cudasign.enumerations.addOptions({
    token: "your login token",
  "enumeration_options": [
    {
      "enumeration_id":"8a3501896160b12d4ef7507a81b2f0998b8137b1",
      "data":"Active"
    },
    {
      "enumeration_id":"8a3501896160b12d4ef7507a81b2f0998b8137b1",
      "data":"Old Navy"
    },
    {
      "enumeration_id":"8a3501896160b12d4ef7507a81b2f0998b8137b1",
      "data":"Volcom"
    }
  ]
}, function(err, res){
    if(!err){
        console.log("RESULTS:" + res);
    }else{
        console.log("ERROR:" + err);
    }
});

Template

Create a Template

cudasign.template.create({
    token: "your login token",
    document_id: "document id",
    document_name: "my template"
}, function(err, res){
    if(!err){
        console.log("RESULTS:" + res);
    }else{
        console.log("ERROR:" + err);
    }
});

Duplicate a Template

cudasign.template.duplicate({
    token: "your login token",
    id: "document id",
    name: "my template"
}, function(err, res){
    if(!err){
        console.log("RESULTS:" + res);
    }else{
        console.log("ERROR:" + err);
    }
});

Folder

Returns a list of folders

cudasign.folder.list({
    "token": "your login token"
}, function(err, res){
  if(!err){
    console.log("RESULTS:" + res);
  }else{
    console.log("ERROR:" + err);
  }
});

Returns a list of documents inside a folder

Filters	Values
`signing-status`	`waiting-for-me`, `waiting-for-others`, `signed`, `pending`
`document-updated`	`new Date()`
`document-created`	`new Date()`

Sort	Values
`document-name`	`asc`/`desc`
`updated`	`asc`/`desc`
`created`	`asc`/`desc`

cudasign.folder.documents({
    "token": "your login token",
    "id": "folder id",
    "filter": [
      {"signing-status": "pending"}
    ],
    "sort": {"document-name":"asc"}
}, function(err, res){
  if(!err){
    console.log("RESULTS:" + res);
  }else{
    console.log("ERROR:" + err);
  }
});

Webhook

Returns a list of Webhooks

cudasign.webhook.list({
    "token": "your login token"
}, function(err, res){
  if(!err){
    console.log("RESULTS:" + res);
  }else{
    console.log("ERROR:" + err);
  }
});

Create a Webhook

Events	Description
`document.create`	Webhook is triggered when a document is uploaded to users account in CudaSign
`document.update`	Webhook is triggered when a document is updated (fields added, text added, signature added, etc.)
`document.delete`	Webhook is triggered when a document is deleted from
`invite.create`	Webhook is triggered when an invitation to a CudaSign document is created.
`invite.update`	Webhook is triggered when an invite to CudaSign document is updated. Ex. A signer has signed the document.

cudasign.webhook.create({
    "token": "your login token",
    "event": "document.create",
    "callback_url": "http://www.domain.com/path"
}, function(err, res){
  if(!err){
    console.log("RESULTS:" + res);
  }else{
    console.log("ERROR:" + err);
  }
});

Unit Tests

To run the unit test you will need to install "Mocha" and "Chai". You also need to create a "test.settings.js" in the root of the CudaSign module. The file will need to contain the following:

(function(){
  "use strict";
  /**
   * Test Settings
   */
 
  exports.settings = {
    credentials: "[ENCODED CLIENT CREDENTIALS]",
    token: "[ACCESS TOKEN]",
    username: "[CUDASIGN USERNAME]",
    password: "[CUDASIGN PASSWORD]",
    documentid: "[EXISTING DOCUMENT ID]",
    templateid: "[EXISTING TEMPLATE ID]",
    folderid: "[EXISTING FOLDER ID]",
    email: "[FROM EMAIL FOR INVITE]",
    testemail: "[TO EMAIL FOR INVITE]"
  };
 
})();

Additional Contact Information

SUPPORT

To contact CudaSign support, please email support@cudasign.com.

SALES

For pricing information, please call (800) 831-2050 or email sales@cudasign.com.

cudasign