You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.MD
+26-26Lines changed: 26 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,31 +7,31 @@ MySuresample application written in Python 3.7 (server) and React (client). You
7
7
8
8
MySure demonstrates the following:
9
9
10
-
1. Authentication with DocuSign via [JSON Web Token (JWT) Grant](https://developers.docusign.com/platform/auth/jwt/)
11
-
2.**Submit a claim:**[Source](./app/api/requests.py)
12
-
This example demonstrates an integration for submitting a claim. It allows you to pass data received from the user to fill in a document. It also adds the ability to attach additional information to the document.
13
-
* The document, based on an HTML template, is combined with Docusign AutoPlace and attachment features.
14
-
* The signing ceremony is implemented with embedded signing for a single signer.
15
-
* The DocuSign signing ceremony is initiated from your website.
16
-
* Anchor text ([AutoPlace](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place/)) is used to position the signing fields in the document.
10
+
1. Authentication with Docusign via [JSON Web Token (JWT) Grant](https://developers.docusign.com/platform/auth/jwt/)
11
+
2.**Submit a claim:**[Source](./app/api/requests.py)
12
+
This example demonstrates an integration for submitting a claim. It allows you to pass data received from the user to fill in a document. It also adds the ability to attach additional information to the document.
13
+
* The document, based on an HTML template, is combined with Docusign AutoPlace and attachment features.
14
+
* The signing ceremony is implemented with embedded signing for a single signer.
15
+
* The Docusign signing ceremony is initiated from your website.
16
+
* Anchor text ([AutoPlace](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place/)) is used to position the signing fields in the document.
17
17
*[Adding attachments](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/documents/attachments/) enables users to add additional information to the document.
18
-
3.**Renew an insurance policy.**[Source](./app/api/clickwrap.py)
19
-
This example shows how to use the Click API to create a clickwrap programmatically, render it in your UI, and and then submit it. It also tracks the submission event and, just after submission, redirects the user to the final page.
20
-
*[More information about Click API](https://developers.docusign.com/docs/click-api)
21
-
4.**Purchase a new insurance policy.**[Source](./app/api/requests.py)
22
-
The example shows how to [request payment using DocuSign](https://developers.docusign.com/docs/esign-rest-api/how-to/request-a-payment/). It's implemented using an HTML-based template with [payment tabs](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/payment/). The document also includes different tab types, such as [Formula](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/calculated-fields/) and
3.**Renew an insurance policy.**[Source](./app/api/clickwrap.py)
19
+
This example shows how to use the Click API to create a clickwrap programmatically, render it in your UI, and and then submit it. It also tracks the submission event and, just after submission, redirects the user to the final page.
20
+
*[More information about Click API](https://developers.docusign.com/docs/click-api)
21
+
4.**Purchase a new insurance policy.**[Source](./app/api/requests.py)
22
+
The example shows how to [request payment using Docusign](https://developers.docusign.com/docs/esign-rest-api/how-to/request-a-payment/). It's implemented using an HTML-based template with [payment tabs](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/payment/). The document also includes different tab types, such as [Formula](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/calculated-fields/) and
The document contains additional logic to calculate the total amount. At completion, the user is able to pay the calculated amount and get back to the original website.
25
+
The document contains additional logic to calculate the total amount. At completion, the user is able to pay the calculated amount and get back to the original website.
26
26
27
27
To use this example, [create a test payments gateway](#user-content-configuring-a-docusign-payments-gateway) for your developer account.
28
28
29
29
## Installation
30
30
31
31
### Prerequisites
32
-
* A DocuSign Developer account (email and password) on [demo.docusign.net](https://demo.docusign.net). If you don't already have a developer account, create a [free account](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16535).
33
-
* A DocuSign integration key (a client ID) that is configured to use **JSON Web Token (JWT) Grant**.
34
-
You will need the **integration key** itself and its **RSA key pair**. To use this application, you must add your application's **Redirect URI** to your integration key. This [**video**](https://www.youtube.com/watch?v=GgDqa7-L0yo) demonstrates how to create an integration key (client ID) for a user application like this example.
32
+
* A Docusign Developer account (email and password) on [demo.docusign.net](https://demo.docusign.net). If you don't already have a developer account, create a [free account](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16535).
33
+
* A Docusign integration key (a client ID) that is configured to use **JSON Web Token (JWT) Grant**.
34
+
You will need the **integration key** itself and its **RSA key pair**. To use this application, you must add your application's **Redirect URI** to your integration key. This [**video**](https://www.youtube.com/watch?v=GgDqa7-L0yo) demonstrates how to create an integration key (client ID) for a user application like this example.
35
35
*[Python 3.7+](https://www.python.org/downloads/)
36
36
* The Python [venv](https://docs.python.org/3/library/venv.html#module-venv) module
37
37
*[Node.js](https://nodejs.org/) v10+
@@ -49,8 +49,8 @@ MySure demonstrates the following:
49
49
***DS_PRIVATE_KEY** - Private key string, source or path; for instance: /app/id_rsa
50
50
***REACT_APP_DS_RETURN_URL** - URL where the back end of the application is located (If you run it locally, use `http://localhost:3000`)
51
51
***REACT_APP_API_BASE_URL** - URL where the front end of the application is located; will be used by Docusign to redirect back after signing ceremony (If you run it locally, use `http://localhost:5001/api`)
52
-
***DS_AUTH_SERVER** - The DocuSign authentication server (for testing purposes, use `https://account-d.docusign.com`)
53
-
***REACT_APP_DS_DEMO_SERVER** - Link to the DocuSign demo server (for testing purposes, use `https://demo.docusign.net`)
52
+
***DS_AUTH_SERVER** - The Docusign authentication server (for testing purposes, use `https://account-d.docusign.com`)
53
+
***REACT_APP_DS_DEMO_SERVER** - Link to the Docusign demo server (for testing purposes, use `https://demo.docusign.net`)
54
54
***REACT_APP_DS_CLICKWRAP_URL** - Link to the hosted clickwrap client (for testing purposes, use `//demo.docusign.net/clickapi/sdk/latest/docusign-click.js`)
55
55
56
56
### Installation steps
@@ -61,7 +61,7 @@ MySure demonstrates the following:
61
61
2. Navigate to that folder: **`cd sample-app-mysure-python`**
4. Install React dependencies using the [npm](https://www.npmjs.com/) package manager: **npm install**
64
-
5. Update the **.env** file with the integration key and other settings.
64
+
5. Update the **.env** file with the integration key and other settings.
65
65
> **Note:** Protect your integration key and client secret. You should make sure that the **.env** file will not be stored in your source code repository.
66
66
6. Navigate to [the admin demo Apps and Keys page](https://admindemo.docusign.com/authenticate?goTo=appsAndKeys), add the Redirect URI http://localhost:3000/callback and then hit save
67
67
@@ -72,15 +72,15 @@ MySure demonstrates the following:
72
72
1. Download or clone this repository to your workstation in a new folder named **sample-app-mysure-python**.
73
73
2. Navigate to the scripts subfolder:**`cd sample-app-mysure-python/scripts`**
74
74
3. Run the installation script: **`./install.sh`** (`./install.bat` for Windows)
75
-
4. Update the **.env** file with the integration key and other settings.
75
+
4. Update the **.env** file with the integration key and other settings.
76
76
> **Note:** Protect your integration key and client secret. You should make sure that the **.env** file will not be stored in your source code repository.
77
77
5. Navigate to [the admin demo Apps and Keys page](https://admindemo.docusign.com/authenticate?goTo=appsAndKeys), add the Redirect URI http://localhost:3000/callback and then hit save
78
78
79
79
### Additional installation scripts
80
80
All installation scripts are located in the **scripts** folder.
81
81
1. To stop the application, run **`./stop.sh`**
82
82
1. To remove the virtual environment and modules, run **`./clean.sh`**
83
-
83
+
84
84
## Running MySure
85
85
86
86
### Manual
@@ -97,15 +97,15 @@ All installation scripts are located in the **scripts** folder.
97
97
2. Run the application script: **`./run.sh`**
98
98
3. Open a browser to **http://localhost:3000**
99
99
100
-
### Configuring a DocuSign payments gateway
101
-
DocuSign offers built-in connections to multiple payment gateways. The payments example in this sample app uses a demo account for the Stripe gateway service.
100
+
### Configuring a Docusign payments gateway
101
+
Docusign offers built-in connections to multiple payment gateways. The payments example in this sample app uses a demo account for the Stripe gateway service.
102
102
103
103
To create the payments gateway account:
104
104
105
105
1. Log in to your [developer account](https://appdemo.docusign.com/) and select Admin.
106
106
2. On the Integrations/Payments screen, click Stripe.
107
-
3. For development, you can skip the Stripe account application by using the `Skip this account form` on the top of the page.
108
-
The Admin Panel will show that an enabled Stripe payment gateway account has been associated with your DocuSign developer account.
107
+
3. For development, you can skip the Stripe account application by using the `Skip this account form` on the top of the page.
108
+
The Admin Panel will show that an enabled Stripe payment gateway account has been associated with your Docusign developer account.
109
109
5. Configure the example launcher with the gateway account ID shown in the Admin panel.
110
110
6. Add the payment gateway account ID to the **.env** file.
<metaname="description" content="See how the MySure DocuSign sample application for insurance incorporates a form enabling a user to sign up for a new policy. The form uses auto-place tabs and DocuSign Payments.">
8
+
<metaname="description" content="See how the MySure Docusign sample application for insurance incorporates a form enabling a user to sign up for a new policy. The form uses auto-place tabs and Docusign Payments.">
9
9
<metaproperty="og:type" content="article" />
10
10
<metaname="twitter:title" content="MySure: Buy New Insurance" />
11
-
<metaname="twitter:description" content="See how the MySure DocuSign sample application for insurance incorporates a form enabling a user to sign up for a new policy. The form uses auto-place tabs and DocuSign Payments." />
11
+
<metaname="twitter:description" content="See how the MySure Docusign sample application for insurance incorporates a form enabling a user to sign up for a new policy. The form uses auto-place tabs and Docusign Payments." />
12
12
<metaproperty="og:title" content="MySure: Buy New Insurance" />
13
-
<metaproperty="og:description" content="See how the MySure DocuSign sample application for insurance incorporates a form enabling a user to sign up for a new policy. The form uses auto-place tabs and DocuSign Payments." />
<metaproperty="og:description" content="See how the MySure Docusign sample application for insurance incorporates a form enabling a user to sign up for a new policy. The form uses auto-place tabs and Docusign Payments." />
<metaname="description" content="See how the MySure DocuSign sample application for insurance allows a user to submit a claim electronically. Functions include embedded signing, auto-place tabs, and optional attachments.">
8
+
<metaname="description" content="See how the MySure Docusign sample application for insurance allows a user to submit a claim electronically. Functions include embedded signing, auto-place tabs, and optional attachments.">
9
9
<metaproperty="og:type" content="article" />
10
10
<metaname="twitter:title" content="MySure: Submit a Claim" />
11
-
<metaname="twitter:description" content="See how the MySure DocuSign sample application for insurance allows a user to submit a claim electronically. Functions include embedded signing, auto-place tabs, and optional attachments." />
11
+
<metaname="twitter:description" content="See how the MySure Docusign sample application for insurance allows a user to submit a claim electronically. Functions include embedded signing, auto-place tabs, and optional attachments." />
12
12
<metaproperty="og:title" content="MySure: Submit a Claim" />
13
-
<metaproperty="og:description" content="See how the MySure DocuSign sample application for insurance allows a user to submit a claim electronically. Functions include embedded signing, auto-place tabs, and optional attachments." />
13
+
<metaproperty="og:description" content="See how the MySure Docusign sample application for insurance allows a user to submit a claim electronically. Functions include embedded signing, auto-place tabs, and optional attachments." />
<metaname="description" content="See how the MySure DocuSign sample application for insurance showcases the capabilities of the DocuSign API to enable you to integrate DocuSign functionality into your own applications.">
21
+
<title>MySure Docusign Sample Application</title>
22
+
<metaname="description" content="See how the MySure Docusign sample application for insurance showcases the capabilities of the Docusign API to enable you to integrate Docusign functionality into your own applications.">
<metaname="twitter:description" content="See how the MySure DocuSign sample application for insurance showcases the capabilities of the DocuSign API to enable you to integrate DocuSign functionality into your own applications." />
<metaproperty="og:description" content="See how the MySure DocuSign sample application for insurance showcases the capabilities of the DocuSign API to enable you to integrate DocuSign functionality into your own applications." />
<metaname="twitter:description" content="See how the MySure Docusign sample application for insurance showcases the capabilities of the Docusign API to enable you to integrate Docusign functionality into your own applications." />
<metaproperty="og:description" content="See how the MySure Docusign sample application for insurance showcases the capabilities of the Docusign API to enable you to integrate Docusign functionality into your own applications." />
0 commit comments