Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/docusign/code-examples-python

Docusign Python code examples and launcher
https://github.com/docusign/code-examples-python

authorization-code-grant click-api docusign flask jwt monitor-api python rooms-api webforms-api

Last synced: 9 months ago
JSON representation

Docusign Python code examples and launcher

Awesome Lists containing this project

README 

          
# Python Launcher Code Examples



>

>### PLEASE! Share your feedback in a [two-question survey](https://docs.google.com/forms/d/e/1FAIpQLScPa74hwhJwi7XWDDj4-XZVOQTF9jJWgbIFEpulXokCqYWT4A/viewform?usp=pp_url&entry.680551577=Python).

>

>

### GitHub repo: [code-examples-python](./README.md)



This GitHub repo includes code examples for the [Web Forms API](https://developers.docusign.com/docs/web-forms-api/), [Docusign Admin API](https://developers.docusign.com/docs/admin-api/), [Click API](https://developers.docusign.com/docs/click-api/), [eSignature REST API](https://developers.docusign.com/docs/esign-rest-api/), [Monitor API](https://developers.docusign.com/docs/monitor-api/), and [Rooms API](https://developers.docusign.com/docs/rooms-api/). 



## Introduction



This repo is a Python 3 application that supports the following authentication workflows:



* Authentication with Docusign via [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode).

When the token expires, the user is asked to re-authenticate. The refresh token is not used.



* Authentication with Docusign via [JSON Web Token (JWT) Grant](https://developers.docusign.com/platform/auth/jwt/).

When the token expires, it updates automatically.



## eSignature API



For more information about the scopes used for obtaining authorization to use the eSignature API, see [Required scopes](https://developers.docusign.com/docs/esign-rest-api/esign101/auth#required-scopes).  



For a list of code examples that use the eSignature API, see the [How-to guides overview](https://developers.docusign.com/docs/esign-rest-api/how-to/) on the Docusign Developer Center.



## Rooms API 



**Note:** To use the Rooms API, you must also [create your Rooms developer account](https://developers.docusign.com/docs/rooms-api/rooms101/create-account). Examples 4 and 6 require that you have the Docusign Forms feature enabled in your Rooms for Real Estate account.  

For more information about the scopes used for obtaining authorization to use the Rooms API, see [Required scopes](https://developers.docusign.com/docs/rooms-api/rooms101/auth/).  



For a list of code examples that use the Rooms API, see the [How-to guides overview](https://developers.docusign.com/docs/rooms-api/how-to/) on the Docusign Developer Center.



## Click API  

For more information about the scopes used for obtaining authorization to use the Click API, see [Required scopes](https://developers.docusign.com/docs/click-api/click101/auth/#required-scopes)  



For a list of code examples that use the Click API, see the [How-to guides overview](https://developers.docusign.com/docs/click-api/how-to/) on the Docusign Developer Center.



## Monitor API



**Note:** To use the Monitor API, you must also [enable Docusign Monitor for your organization](https://developers.docusign.com/docs/monitor-api/how-to/enable-monitor/).  



For information about the scopes used for obtaining authorization to use the Monitor API, see the [scopes section](https://developers.docusign.com/docs/monitor-api/monitor101/auth/). 



For a list of code examples that use the Monitor API, see the [How-to guides overview](https://developers.docusign.com/docs/monitor-api/how-to/) on the Docusign Developer Center.



## Admin API



**Note:** To use the Admin API, you must [create an organization](https://support.docusign.com/en/guides/org-admin-guide-create-org) in your Docusign developer account. Also, to run the Docusign CLM code example, [CLM must be enabled for your organization](https://support.docusign.com/en/articles/DocuSign-and-SpringCM).



For information about the scopes used for obtaining authorization to use the Admin API, see the [scopes section](https://developers.docusign.com/docs/admin-api/admin101/auth/).



For a list of code examples that use the Admin API, see the [How-to guides overview](https://developers.docusign.com/docs/admin-api/how-to/) on the Docusign Developer Center.



## Web Forms API



The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact [Docusign Support](https://support.docusign.com/) or your account manager to find out whether the Web Forms API is available for your production account plan.



For more information about the scopes used for obtaining authorization to use the Rooms API, see [Required scopes](https://developers.docusign.com/docs/web-forms-api/plan-integration/authentication/).



For a list of code examples that use the Web Forms API, see the [How-to guides overview](https://developers.docusign.com/docs/web-forms-api/how-to/) on the Docusign Developer Center.



## Installation



### Prerequisites

**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/) from the Docusign Developer Center, skip items 1 and 2 as they were automatically performed for you.



1. A free [Docusign developer account](https://go.docusign.com/o/sandbox/); create one if you don't already have one.

1. A Docusign app and integration key that is configured to use either [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) or [JWT Grant](https://developers.docusign.com/platform/auth/jwt/) authentication.



   This [video](https://www.youtube.com/watch?v=eiRI4fe5HgM) demonstrates how to obtain an integration key.  

   

   To use [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/), you will need an integration key and a secret key. See [Installation steps](#installation-steps) for details.  



   To use [JWT Grant](https://developers.docusign.com/platform/auth/jwt/), you will need an integration key, an RSA key pair, and the User ID GUID of the impersonated user. See [Installation steps for JWT Grant authentication](#installation-steps-for-jwt-grant-authentication) for details.  



   For both authentication flows:  

   

   If you use this launcher on your own workstation, the integration key must include a redirect URI of http://localhost:3000/ds/callback



   If you host this launcher on a remote web server, set your redirect URI as   

   

   {base_url}/ds/callback

   

   where {base_url} is the URL for the web app.



1. Python 3.

1. If you are working on a Windows with a Python version after 3.10 you will also need to install [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022). After installing that run `pip install --upgrade setuptools`.



### Installation steps



**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/) from the Docusign Developer Center, skip step 4 as it was automatically performed for you.



1. Extract the Quickstart ZIP file or download or clone the code-examples-python repository.

1. In your command-line environment, switch to the folder:  

   `cd ` or `cd code-examples-python`

1. To install dependencies, run: `pip3 install -r requirements.txt`  (or pipenv can be used)

1. To configure the launcher for [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) authentication, create a copy of the file app/ds_config_sample.py and save the copy as app/ds_config.py.

   1. Add your integration key. On the [Apps and Keys](https://admindemo.docusign.com/authenticate?goTo=apiIntegratorKey) page, under **Apps and Integration Keys**, choose the app to use, then select **Actions > Edit**. Under **General Info**, copy the **Integration Key** GUID and save it in ds_config.py as your `ds_client_id`.

   1. Generate a secret key, if you don’t already have one. Under **Authentication**, select **+ ADD SECRET KEY**. Copy the secret key and save it in ds_config.py as your `ds_client_secret`.

   1. Add the launcher’s redirect URI. Under **Additional settings**, select **+ ADD URI**, and set a redirect URI of http://localhost:3000/ds/callback. Select **SAVE**.   

   1. Set a name and email address for the signer. In ds_config.py, save an email address as `signer_email` and a name as `signer_name`.  

**Note:** Protect your personal information. Please make sure that ds_config.py will not be stored in your source code repository.

1. Run the launcher:`python run.py`  

   **Note:** You will need to alias the python command to run Python 3 or use `python3 run.py`

1. Open a browser to http://localhost:3000



### Installation steps with docker



**Note**: Running the launcher with docker will use Python 3.11



1. Open the Docker application

1. `docker image build -t docusign .`

1. `docker run --name docusign_python -p 3000:3000 -d docusign`

1. Open a browser to http://localhost:3000



### Installation steps for JWT Grant authentication



**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/) from the Docusign Developer Center, skip step 4 as it was automatically performed for you.  

Also, in order to select JSON Web Token authentication in the launcher, in app/ds_config.py, change the `quickstart` setting to `"false"`.



1. Extract the Quickstart ZIP file or download or clone the code-examples-python repository.

1. In your command-line environment, switch to the folder: `cd ` or `cd code-examples-python`

1. To install dependencies, run: `pip3 install -r requirements.txt`  (or pipenv can be used)

1. To configure the launcher for [JWT Grant](https://developers.docusign.com/platform/auth/jwt/) authentication, create a copy of the file app/ds_config_sample.py and save the copy as app/ds_config.py.

   1. Add your User ID. On the [Apps and Keys](https://admindemo.docusign.com/authenticate?goTo=apiIntegratorKey) page, under **My Account Information**, copy the **User ID** GUID and save it in ds_config.py as your `ds_impersonated_user_id`.

   1. Add your integration key. On the [Apps and Keys](https://admindemo.docusign.com/authenticate?goTo=apiIntegratorKey) page, under **Apps and Integration Keys**, choose the app to use, then select **Actions > Edit**. Under **General Info**, copy the **Integration Key** GUID and save it in ds_config.py as your `ds_client_id`.

   1. Generate an RSA key pair, if you don’t already have one. Under **Authentication**, select **+ GENERATE RSA**. Copy the private key, and save it in a new file named app/private.key.   

   1. Add the launcher’s redirect URI. Under **Additional settings**, select **+ ADD URI**, and set a redirect URI of http://localhost:3000/ds/callback. Select **SAVE**.   

   1. Set a name and email address for the signer. In ds_config.py, save an email address as `signer_email` and a name as `signer_name`.  

**Note:** Protect your personal information. Please make sure that your ds_config.py and private.key files will not be stored in your source code repository.  

1. Run the launcher:`python run.py`  

   **Note:** You will need to alias the python command to run Python 3 or use `python3 run.py`   

1. Open a browser to http://localhost:3000

1. On the black navigation bar, select **Login**.

1. From the picklist, select **JSON Web Token** > **Authenticate with Docusign**.

1. When prompted, log in to your Docusign developer account. If this is your first time using the app, select **ACCEPT** at the consent window. 

1. Select your desired code example.



## JWT grant remote signing and Authorization Code Grant embedded signing projects



See [Docusign Quickstart overview](https://developers.docusign.com/docs/esign-rest-api/quickstart/overview/) on the Docusign Developer Center for more information on how to run the JWT grant remote signing project and the Authorization Code Grant embedded signing project.



### Installation steps for JWT grant remote signing example



Follow the instructions below if you downloaded the JWT grant remote signing example.



1. Extract the Quickstart ZIP file or download or clone the code-examples-python repository.

1. Run the JWT console project: `python jwt_console.py`. If you do not already have the docusign-esign package, it will be 

   installed for you when you start the project.

  **Note:** You will need to alias the python command to run Python 3 or use `python3 run.py`

1. Follow the prompts from the command line to grant consent in your browser.

1. Return to the command line and follow the prompts to enter the names and email addresses of your recipients.

1. Check your email to sign the example document.



## Payments code example  



To use the payments code example, create a test payment gateway on the [Payments](https://admindemo.docusign.com/authenticate?goTo=payments) page in your developer account. See [Configure a payment gateway](./PAYMENTS_INSTALLATION.md) for details.



Once you've created a payment gateway, save the **Gateway Account ID** GUID to ds_config.py.



## License and additional information  



### License  

This repository uses the MIT License. See [LICENSE](./LICENSE) for details.



### Pull Requests

Pull requests are welcomed. Pull requests will only be considered if their content

uses the MIT License.