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 = ;;
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:
- In the response's
envelope_id
field. - 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 = ;
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