https://github.com/carlganz/docusignr
docuSign API
https://github.com/carlganz/docusignr
curl docusign httr r
Last synced: 3 months ago
JSON representation
docuSign API
- Host: GitHub
- URL: https://github.com/carlganz/docusignr
- Owner: carlganz
- License: gpl-3.0
- Created: 2017-03-25T02:55:25.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-07-02T22:43:11.000Z (almost 6 years ago)
- Last Synced: 2025-04-02T17:15:34.442Z (3 months ago)
- Topics: curl, docusign, httr, r
- Language: R
- Size: 85 KB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.Rmd
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
---
output: github_document
---
[](https://travis-ci.org/CannaData/docuSignr)[](https://ci.appveyor.com/project/CannaData/docuSignR)
# docuSignr
[DocuSign](https://www.docusign.com/) is the leader in online document signing. They provide a REST API which allows for [embedded document](https://www.docusign.com/developer-center/recipes/signing-from-your-app) signing in several server-side languages, not currently including R.
The `docuSignr` package uses `httr` to embed DocuSign into Shiny applications.
# Installation
`docuSignr` is available on CRAN and Github.
```{R, eval = FALSE}
# from CRAN
install.packages("docuSignr")
# from Github
devtools::install_github("CannaData/docuSignr")
```
# Requirements
For `docuSignr` to function you will need several things:
- DocuSign account
- DocuSign integrator key
- DocuSign templates
- DocuSign envelopes
# Set-Up
It is recommended that you set the DocuSign username, password, and integrator key as environmental variables idealy in your .Rprofile.
```{R,eval =FALSE}
Sys.setenv("docuSign_username" = "username")
Sys.setenv("docuSign_password" = "password")
Sys.setenv("docuSign_integrator_key" = "integrator_key")
```
# Example
```{R, eval = FALSE}
library(docuSignr)
# login to get baseURL and accountID
login <- docu_login()
# load templates
templates <- docu_templates(base_url = login[1, "baseUrl"])
# create envelope
envelope <- docu_envelope(
account_id = login[1, "accountId"],
base_url = login[1, "baseUrl"],
template_id = templates[1, "templateId"],
template_roles = list(
email = "[email protected]",
name = "R-Test",
roleName = "Patient",
clientUserId = "1"
),
email_subject = "R-Test",
email_blurb = "R-Test"
)
# get URL
URL <- docu_embed(
base_url = login[1, "baseUrl"],
return_url = "https://www.google.com",
envelope_id = envelope$envelopeId,
# info here must be consistent with info in template_roles above
signer_name = "R-Test",
signer_email = "[email protected]",
client_user_id = "1"
)
# sign document
browseURL(URL)
```
# Code of Conduct
Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.
Also see [contributing](CONTRIBUTE.md).