docusignapi

The goal of docusignapi is to connect to docuSign and query the API

Installation

You can install the development version of docusignapi like so:

# install.packages("remotes")
remotes::install_github("HIBio/docusignapi")

Prerequisites

You will initially need a docuSign developer account (free). From there, you can find your integrator_key, and create an app secret. Store these in your .Renviron with usethis::edit_r_environ(). You will also need to store the base URL for the environment you are using - initially, this is the developer sandbox

docuSign_integrator_key=f123abc8-4e42-1abc-92c9-0e1d233d4567
docuSign_secret_key=f4f123d4-d5b6-4123-bf42-8492a12345e2
docuSign_base_url=https://demo.docusign.net/
docuSign_demo=TRUE

If you know the account ID you will always be querying, you can also set docuSign_account_id here.

The secret can be created in settings for the developer account, where you will also need to set the redirect URI to “https://localhost:16000”.

Authentication

Running get_token() will authenticate via a browser and save the token as .docusign_token in the package-supplied environment docusign_env. This will be used for all queries.

library(docusignapi)

get_token()

To load a saved token into this object, use store_token(token).

Example

With the token available, queries can be made to the docuSign API. If the account_id is not specified, either the environment variable docuSign_account_id or get_user() will be used.

me <- get_user()
me$name
#> [1] "Service Account"

envelopes <- list_envelopes()
envelopes$envelopes[[1]]$status
#> [1] "completed"

folders <- list_folders()
sapply(folders$folders, \(x) x$name)
#> [1] "Draft"         "Inbox"         "Deleted Items" "Sent Items"

Current capabilities:

• get_user - user metadata
• list_envelopes - list available envelopes
• list_envelope_custom_fields - list custom fields on an envelope
• list_documents - list available documents within an envelope
• list_document_fields - list available fields on a document
• get_document - download a document from an envelope (PDF)
• list_folders - list available folders
• list_folder_contents - list content of a folder
• template_query - follow a URI listed in a result, e.g. “/envelopes/c01ca123-c2b2-1faa-a89f-1b2da345e678/recipients”

Promoting to Production

In order to promote the app to a production account you will need to satisfy the go-live requirements, which includes performing 20 successful API calls which do not violate the docuSign terms, including polling (requesting the same envelope more than once in a 15 minute window). In order to accomplish this, I suggest creating two envelopes in the developer sandbox, then performing the following queries two times, separated by 20 minutes. Store the names of the uploaded files in the variables below

file_1_name <- "nameoffirstfile.pdf"
file_2_name <- "nameofsecondfile.pdf" 

library(docusignapi)
get_token()
me <- get_user()
envelopes <- list_envelopes()
env1 = envelopes$envelopes[[1]]$envelopeId
env2 = envelopes$envelopes[[2]]$envelopeId
list_envelope_custom_fields(envelope_id = env1)
list_document_fields(envelope_id = env1, document_id = 1)
list_document_fields(envelope_id = env2, document_id = 1)
list_documents(envelope_id = env1)
list_documents(envelope_id = env2)
get_document(envelope_id = env1, document_id = 1, filename = file_1_name)
get_document(envelope_id = env2, document_id = 1, filename = file_2_name)
folders <- list_folders()
sapply(folders$folders, \(x) x$name)
list_folder_contents(folder_id = folders$folders[[1]]$folderId)

Once that is successful, the app can be sent for go-live review. On success, it can be promoted to a production account, at which point you will need to set a redirect URI and create a new secret to be stored in your .Rprofile. Set docuSign_demo=FALSE to use the production API.