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
This GitHub repo includes code examples for the DocuSign Admin API, Click API, eSignature REST API, Monitor API, and Rooms API.
5
+
This GitHub repo includes code examples for the Docusign Admin API, Click API, eSignature REST API, Monitor API, and Rooms API.
6
6
7
7
8
8
## Introduction
9
9
10
10
This repo is a Java Spring Boot application that supports the following authentication workflows:
11
11
12
-
* Authentication with DocuSign via [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode).
12
+
* Authentication with Docusign via [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode).
13
13
When the token expires, the user is asked to re-authenticate. The refresh token is not used.
14
14
15
-
* Authentication with DocuSign via [JSON Web Token (JWT) Grant](https://developers.docusign.com/platform/auth/jwt/).
15
+
* Authentication with Docusign via [JSON Web Token (JWT) Grant](https://developers.docusign.com/platform/auth/jwt/).
16
16
When the token expires, it updates automatically.
17
17
18
18
The [Spring Boot security Oauth2 boot autoconfigure package](https://github.com/spring-projects/spring-security-oauth2-boot/blob/master/spring-security-oauth2-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/resource/UserInfoRestTemplateCustomizer.java) is used for authentication.
@@ -24,57 +24,57 @@ The OAuth library is used in the file [WebSecurityConfig.java](https://github.co
24
24
25
25
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).
26
26
27
-
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.
27
+
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.
28
28
29
29
30
30
## Rooms API
31
31
32
-
**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.
32
+
**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.
33
33
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/).
34
34
35
-
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.
35
+
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.
36
36
37
37
38
38
## Click API
39
39
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)
40
40
41
-
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.
41
+
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.
42
42
43
43
44
44
## Monitor API
45
45
46
-
**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/).
46
+
**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/).
47
47
48
48
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/).
49
49
50
-
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.
50
+
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.
51
51
52
52
53
53
## Admin API
54
54
55
-
**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).
55
+
**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).
56
56
57
57
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/).
58
58
59
-
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.
59
+
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.
60
60
61
61
62
62
## Web Forms API
63
63
64
-
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.
64
+
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.
65
65
66
66
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/).
67
67
68
-
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.
68
+
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.
69
69
70
70
71
71
## Installation
72
72
73
73
### Prerequisites
74
-
**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.
74
+
**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.
75
75
76
-
1. A free [DocuSign developer account](https://go.docusign.com/o/sandbox/); create one if you don't already have one.
77
-
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.
76
+
1. A free [Docusign developer account](https://go.docusign.com/o/sandbox/); create one if you don't already have one.
77
+
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.
78
78
79
79
This [video](https://www.youtube.com/watch?v=eiRI4fe5HgM) demonstrates how to obtain an integration key.
80
80
@@ -103,7 +103,7 @@ For a list of code examples that use the Web Forms API, see the [How-to guides o
103
103
104
104
### Installation steps
105
105
106
-
**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.
106
+
**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.
107
107
108
108
1. Extract the Quickstart ZIP file or download or clone the code-examples-java repository.
109
109
1. In your command-line environment, switch to the :
@@ -142,7 +142,7 @@ For Windows:
142
142
143
143
### Installation steps for JWT Grant authentication
144
144
145
-
**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.
145
+
**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.
146
146
Also, in order to select JSON Web Token authentication in the launcher, in src/main/resources/application.json, change the `quickstart` setting to `false`.
147
147
148
148
1. Extract the Quickstart ZIP file or download or clone the code-examples-java repository.
@@ -158,7 +158,7 @@ Also, in order to select JSON Web Token authentication in the launcher, in src/m
158
158
1. Run the launcher: `mvn exec:java -Dexec.mainClass="com.docusign.jwtconsoleapp.JWTConsoleApp"` (`mvn exec:java -D"exec.mainClass"="com.docusign.jwtconsoleapp.JWTConsoleApp"`)
159
159
The launcher automatically opens.
160
160
1. On the black navigation bar, select **Login**.
161
-
1. From the picklist, select **JSON Web Token (JWT) grant** > **Authenticate with DocuSign**.
161
+
1. From the picklist, select **JSON Web Token (JWT) grant** > **Authenticate with Docusign**.
162
162
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.
163
163
3. Select your desired code example.
164
164
@@ -167,7 +167,7 @@ Also, in order to select JSON Web Token authentication in the launcher, in src/m
167
167
168
168
IntelliJ IDEA can be used with the launcher. The [IntelliJ IDEA Ultimate edition](https://www.jetbrains.com/idea/download/#section=windows) is required due to its support for Spring Boot and JSP view pages.
169
169
170
-
**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/) from the DocuSign Developer Center, skip step 2 as it was automatically performed for you.
170
+
**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/) from the Docusign Developer Center, skip step 2 as it was automatically performed for you.
171
171
172
172
1. Extract the Quickstart ZIP file or download or clone the code-examples-java repository.
173
173
1. To configure the launcher for [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) authentication, create a copy of the file src/main/resources/application.example.json and save the copy as src/main/resources/application.json.
@@ -185,14 +185,14 @@ IntelliJ IDEA can be used with the launcher. The [IntelliJ IDEA Ultimate edition
185
185
1. To the right of **Main class**, select **... > App (com.docusign) code-examples-java**, then select **OK**.
186
186
1. Under **Spring Boot**, select the **Enable debug output** checkbox, then select **OK**.
187
187
1. Run the launcher: In the top navigation bar, select **Run > Run 'App'**. The launcher automatically opens.
188
-
When prompted, log in to your DocuSign developer account. If this is your first time using the app, select **ACCEPT** at the consent window.
188
+
When prompted, log in to your Docusign developer account. If this is your first time using the app, select **ACCEPT** at the consent window.
189
189
1.[Optional] To install Lombok, select **File > Settings > Plugins > Marketplace** tab. To the right of the magnifying glass icon, input: `Lombok`
190
190
It should have an author named Michail Plushnikov. Select **Install**, then restart IntelliJ.
191
191
192
192
193
193
## Eclipse instructions for Windows
194
194
195
-
**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/) from the DocuSign Developer Center, skip step 2 as it was automatically performed for you.
195
+
**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/) from the Docusign Developer Center, skip step 2 as it was automatically performed for you.
196
196
197
197
1. Extract the Quickstart ZIP file or download or clone the code-examples-java repository.
198
198
1. To configure the launcher for [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) authentication, create a copy of the file src/main/resources/application.example.json and save the copy as src/main/resources/application.json.
@@ -217,11 +217,11 @@ IntelliJ IDEA can be used with the launcher. The [IntelliJ IDEA Ultimate edition
217
217
1. In the **Main class** field, input: `com.docusign.App`
218
218
1. Select the **JRE** tab. Under **Runtime JRE**, ensure it lists jdk-11 or higher. Select **Apply** to save.
219
219
1. Select **Run** to run the launcher. The launcher automatically opens.
220
-
When prompted, log in to your DocuSign developer account. If this is your first time using the app, select **ACCEPT** at the consent window.
220
+
When prompted, log in to your Docusign developer account. If this is your first time using the app, select **ACCEPT** at the consent window.
221
221
1.[Optional] Download [lombok.jar](https://projectlombok.org/downloads/lombok.jar) to your local machine, then run the following command to install Lombok: `java -jar lombok.jar`
222
222
223
223
## JWT grant remote signing project
224
-
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.
224
+
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.
0 commit comments