Giter Site home page Giter Site logo

eg-01-csharp-jwt-framework's Introduction

Example 1: C# .NET Framework Service Integration

Repository: eg-01-csharp-jwt-framework

Introduction

This software is an example of a System Integration. This type of application interacts with DocuSign on its own. There is no user interface and no user is present during normal operation.

The application uses the OAuth JWT grant flow to impersonate a user in the account.

This launcher example includes two examples:

  1. Send an html, Word, and PDF file in an envelope to be signed.
  2. List the envelopes in the account that are less than 30 days old.

Installation

Requirements: C# and .NET Framework v4.5 or later.

This repository has been tested as a Visual Studio 2017 Community Edition solution.

Short installation instructions

  • Download or clone this repository.

  • The repository includes a Visual Studio 2017 solution file and NuGet package references in the project file.

  • Configure the project by editing the existing project file common/App.config

    See the Configuration section, below, for more information.

  • The solution's Main class is in common/Program.cs

Configure the example

Configure the example via the common/App.config file.

Recommendation: add common/App.config to your .gitignore file so your private information will not be added to your repository.

Do not store your Integration Key, private key, or other private information in your code repository.

Creating the Integration Key

Your DocuSign Integration Key must be configured for a JWT OAuth authentication flow:

  • Using the DocuSign Admin tool, create a public/private key pair for the integration key. Store the private key in a secure location. You can use a file or a key vault.
  • The example requires the private key. Store the private key in the App.config file.
  • If you will be using individual consent grants, you must create a Redirect URI for the key. Any URL can be used. By default, this example uses https://www.docusign.com

The impersonated user's guid

The JWT will impersonate a user within your account. The user can be an individual or a user representing a group such as "HR".

The example needs the guid assigned to the user.

The guid value for each user in your account is available from the DocuSign Admin tool in the Users section. To see a user's guid, Edit the user's information. On the Edit User screen, the guid for the user is shown as the API Username.

Run the examples

Build, then run the solution to see its output.

The common files

This repository is configured for use with .NET Framework. The source files, stored in the /common directory, also work (unchanged) with .NET Core.

A .NET Core version of this example is also available. It uses the same common set of source files, but is configured as a .NET Core solution for Visual Studio 2017.

Support, Contributions, License

Submit support questions to StackOverflow. Use tag docusignapi.

Contributions via Pull Requests are appreciated. Pull requests for the common files must be contributed to the eg-01-csharp-jwt-common repository. See the Contributing.md file for information on contributing to this project.

All contributions must use the MIT License.

This repository uses the MIT license, see the LICENSE file.

eg-01-csharp-jwt-framework's People

Contributors

larryklugerds avatar shadim avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.