Skip to content

Commit 31e30f5

Browse files
committed
Updating README.md
1 parent fced678 commit 31e30f5

File tree

1 file changed

+45
-45
lines changed

1 file changed

+45
-45
lines changed

README.md

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -5,45 +5,45 @@
55
>
66
### GitHub repo: [code-examples-csharp](./README.md)
77

8-
This GitHub repo includes code examples for the [Web Forms API](https://developers.docusign.com/docs/web-forms-api/), [Maestro API](https://developers.docusign.com/docs/maestro-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/).
8+
This GitHub repo includes code examples for the [Web Forms API](https://developers.docusign.com/docs/web-forms-api/), [Maestro API](https://developers.docusign.com/docs/maestro-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/).
99

1010

1111
## Introduction
12-
This repo is a C# .NET Core MVC application that demonstrates:
12+
This repo is a C# .NET Core MVC application that demonstrates:
1313

1414
* Authentication with Docusign via [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode).
15-
When the token expires, the user is asked to re-authenticate. The refresh token is not used.
15+
When the token expires, the user is asked to re-authenticate. The refresh token is not used.
1616

1717
* Authentication with Docusign via [JSON Web Token (JWT) Grant](https://developers.docusign.com/platform/auth/jwt/).
18-
When the token expires, it updates automatically.
18+
When the token expires, it updates automatically.
1919

2020

2121
## eSignature API
2222

23-
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).
23+
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).
2424

2525
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.
2626

2727

28-
## Rooms API
28+
## Rooms API
2929

30-
**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.
31-
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/).
30+
**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.
31+
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/).
3232

3333
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.
3434

3535

36-
## Click API
37-
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)
36+
## Click API
37+
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)
3838

3939
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.
4040

4141

4242
## Monitor API
4343

44-
**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/).
44+
**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/).
4545

46-
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/).
46+
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/).
4747

4848
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.
4949

@@ -69,64 +69,64 @@ For a list of code examples that use the Web Forms API, see the [How-to guides o
6969
## Installation
7070

7171
### Prerequisites
72-
**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.
72+
**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.
7373

74-
1. A free [Docusign developer account](https://go.docusign.com/o/sandbox/); create one if you don't already have one.
75-
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.
74+
1. A free [Docusign developer account](https://www.docusign.com/developers/sandbox); create one if you don't already have one.
75+
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.
7676

77-
This [video](https://www.youtube.com/watch?v=eiRI4fe5HgM) demonstrates how to obtain an integration key.
78-
79-
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.
77+
This [video](https://www.youtube.com/watch?v=eiRI4fe5HgM) demonstrates how to obtain an integration key.
8078

81-
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.
79+
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.
8280

83-
For both authentication flows:
84-
85-
If you use this launcher on your own workstation, the integration key must include a redirect URI of https://localhost:44333/ds/callback
81+
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.
8682

87-
If you host this launcher on a remote web server, set your redirect URI as
88-
89-
{base_url}/ds/callback
90-
91-
where {base_url} is the URL for the web app.
92-
93-
1. [C# .NET Core](https://dotnet.microsoft.com/download/dotnet-core) 3.1 or later.
83+
For both authentication flows:
84+
85+
If you use this launcher on your own workstation, the integration key must include a redirect URI of https://localhost:44333/ds/callback
86+
87+
If you host this launcher on a remote web server, set your redirect URI as
88+
89+
{base_url}/ds/callback
90+
91+
where {base_url} is the URL for the web app.
92+
93+
1. [Microsoft .NET](https://dotnet.microsoft.com/en-us/download) 8.0 or later.
9494
1. [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/) with ASP.NET package
9595

9696

9797
### Installation steps
9898
**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.
9999

100100
1. Extract the Quickstart ZIP file or download or clone the code-examples-csharp repository.
101-
1. In File Explorer, open your Quickstart folder or your code-examples-csharp folder.
101+
1. In File Explorer, open your Quickstart folder or your code-examples-csharp folder.
102102
1. Open the project with Visual Studio by double-clicking the launcher-csharp.sln file.
103103
1. To configure the launcher for [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) authentication, create a copy of the file launcher-csharp/appsettings.example.json and save the copy as launcher-csharp/appsettings.json.
104104
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 appsettings.json as your `ClientId`.
105105
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 appsettings.json as your `ClientSecret`.
106-
1. Add the launcher’s redirect URI. Under **Additional settings**, select **+ ADD URI**, and set a redirect URI of https://localhost:44333/ds/callback. Select **SAVE**.
107-
1. Set a name and email address for the signer. In appsettings.json, save an email address as `SignerEmail` and a name as `SignerName`.
106+
1. Add the launcher’s redirect URI. Under **Additional settings**, select **+ ADD URI**, and set a redirect URI of https://localhost:44333/ds/callback. Select **SAVE**.
107+
1. Set a name and email address for the signer. In appsettings.json, save an email address as `SignerEmail` and a name as `SignerName`.
108108
1. Run the launcher with Visual Studio: Select the green Play **IIS Express** button.
109109

110110

111111
### Installation steps for JWT Grant authentication
112112

113-
**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.
114-
Also, in order to select JSON Web Token authentication in the launcher, in launcher-csharp/appsettings.json, change the `quickstart` setting to `"false"`.
113+
**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.
114+
Also, in order to select JSON Web Token authentication in the launcher, in launcher-csharp/appsettings.json, change the `quickstart` setting to `"false"`.
115115

116116
1. Extract the Quickstart ZIP file or download or clone the code-examples-csharp repository.
117-
1. In File Explorer, open your Quickstart folder or your code-examples-powershell folder.
117+
1. In File Explorer, open your Quickstart folder or your code-examples-powershell folder.
118118
1. Open the launcher-csharp.sln solution file using Visual Studio.
119119
1. To configure the launcher for [JWT Grant](https://developers.docusign.com/platform/auth/jwt/) authentication, create a copy of the file launcher-csharp/appsettings.example.json and save the copy as launcher-csharp/appsettings.json.
120120
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 appsettings.json as your `ImpersonatedUserId`.
121121
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 appsettings.json as your `ClientId`.
122-
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 launcher-csharp/private.key.
123-
1. Add the launcher’s redirect URI. Under **Additional settings**, select **+ ADD URI**, and set a redirect URI of https://localhost:44333/ds/callback. Select **SAVE**.
124-
1. Set a name and email address for the signer. In appsettings.json, save an email address as `SignerEmail` and a name as `SignerName`.
125-
**Note:** Protect your personal information. Please make sure that appsettings.json will not be stored in your source code repository.
126-
1. Run the launcher with Visual Studio: Select the green **Play IIS** Express button.
122+
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 launcher-csharp/private.key.
123+
1. Add the launcher’s redirect URI. Under **Additional settings**, select **+ ADD URI**, and set a redirect URI of https://localhost:44333/ds/callback. Select **SAVE**.
124+
1. Set a name and email address for the signer. In appsettings.json, save an email address as `SignerEmail` and a name as `SignerName`.
125+
**Note:** Protect your personal information. Please make sure that appsettings.json will not be stored in your source code repository.
126+
1. Run the launcher with Visual Studio: Select the green **Play IIS** Express button.
127127
1. On the black navigation bar, select **Login**.
128128
1. From the picklist, select **JWT (JSON Web Token)** > **Authenticate with Docusign**.
129-
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.
129+
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.
130130
1. Select your desired code example.
131131

132132
## Authorization Code Grant embedded signing example:
@@ -137,15 +137,15 @@ Also, in order to select JSON Web Token authentication in the launcher, in launc
137137
1. Double click the JWT-Console.csproj file in the JWT-Console folder of your Quickstart project.
138138
1. Select the green Play JWT Console button.
139139

140-
## Payments code example
141-
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.
140+
## Payments code example
141+
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.
142142

143143
Once you've created a payment gateway, save the **Gateway Account ID** GUID to appsettings.json.
144144

145145

146-
## License and additional information
146+
## License and additional information
147147

148-
### License
148+
### License
149149
This repository uses the MIT License. See [LICENSE](./LICENSE) for details.
150150

151151
### Pull Requests

0 commit comments

Comments
 (0)