node-docusign-signing-ceremony-url v1.0.3

node-docusign-signing-ceremony-url

Provide configuration data, get an embeddable Docusign signing ceremony URL. Also allows for the retrieval of pdf.

Docusign provides an official Node frontend for its API, but for simple tasks, it can be a little... convoluted. This package is a wrapper over Docusign's API that focuses on exactly one thing: Generating a URL for a "signing ceremony." A "signing ceremony," in Docusign's parlance, is a UX wherein a user can sign and submit a document.

Getting the Signing Ceremony URL

This package exports a function called getSigningCeremonyUrl, which returns a promise that resolves to an object that contains a signing ceremony URL:

const getSigningCeremonyUrl = require('get-signing-ceremony-url');

getSigningCeremonyUrl({
  signerName: 'Johnny Signer',
  signerEmail: 'noreply@lolstopreplying.com',
  returnUrl: 'http://www.hamsterdance.org/hamsterdance/',
  emailSubject: 'Hello I am an email',

  // Replace these fields with actual credentials if you want anything to work
  username: 'hey-hey-hey-put-your-docusign-login-info@here.pizza',
  password: 'correct horse battery staple',
  integratorKey: 'i-dont-actually-know-why-docusign-needs-this-but-hey-whatever-just-paste-it-in-here'
  templateId: 'you-really-should-put-a-template-id-here',

  tabs: {
    signHere: [{
      documentId: 1,
      pageNumber: 1,
      recipientId: 1,
      x: 100,
      y: 100,
    }, {
      documentId: 1,
      pageNumber: 1,
      recipientId: 1,
      x: 300,
      y: 300,
    }],
    date: [{
      documentId: 1,
      pageNumber: 1,
      recipientId: 1,
      x: 0,
      y: 0
    }]
  }
}).then(
  response => require('child_process').exec(`open ${response.url}`)
).catch(
  console.error
);

Currently this package assumes that the document you want to have signed is already uploaded to Docusign as a template. Read this to learn how to find a template's ID.

Envelope information

The method also provides the created Envelope's ID in two forms:

1. In the response's envelope_id field.
2. Appended to the returnUrl:

https://my.return.url.com/ -> https://my.return.url.com/?envelope_id=THE_ENVELOPE_ID

Retrieving documents from an envelope

const getEnvelopeDocuments = require('get-envelope-documents');

getEnvelopeDocuments({
  username: 'your-username',
  password: 'your-password',
  integratorKey: 'your-integrator-key',
  docusignEnvironment: 'your-docusign-env--eg--demo',
  envelopeID: 'envelope-that-contain-desired-docs'
}).then(response => {
  // Do something with response.body 
})

Tests

The tests hit Docusign's live API, so they are a bit slow to run. Before you can run them successfully, you will need to put your account credentials into docusign-credentials.json. Once you've done that, run:

npm test