Skip to content

docusign/docusign-webforms-java-client

Repository files navigation

The Official Docusign WebForms Java Client SDK

Build status Maven Central status

The Docusign SDK makes integrating Docusign into your apps and websites a seamless experience.

Table of Contents

Introduction

Leverage the power of Web Forms in your agreement processes. Enjoy greater flexibility to manage forms using your own code including the creation and management of form instances with prefilled data. This API works with Docusign JS to enable the embedding of a web form instance in your web application.

Installation

This client SDK is provided as open source, which enables you to customize its functionality to suit your particular use case. To do so, download or clone the repository. If the SDK’s given functionality meets your integration needs, or if you’re working through our code examples from the Docusign Developer Center, you merely need to install it by following the instructions below.

Version Information

  • API version: 1.1.0
  • Latest SDK version (Including prerelease):

Requirements

Compatibility

  • Java 1.9+

Note: Docusign uses Eclipse with Maven for testing purposes.

Maven:

  1. In Eclipse, create a new project by selecting File > New > Project.
  2. In the New Project Wizard, expand Maven, then select Maven Project.
  3. Leave Create a simple project unchecked.
  4. Select Next, then provide a unique groupId and artifactId.
  5. In the directory where you've saved your project, open the pom.xml file.
  6. In the pom.xml file, locate the dependencies node.
  7. Add:
    <dependency>
      <groupId>com.docusign</groupId>
      <artifactId>docusign-webforms-java</artifactId>
      <version>2.0.0</version>
    </dependency>
    
  8. If your project is still open, restart Eclipse.

SDK Dependencies

This client has the following external dependencies:

  • io.swagger.core.v3:swagger-annotations:2.2.8
  • org.glassfish.jersey.core:jersey-client:3.1.6
  • org.glassfish.jersey.media:jersey-media-multipart:3.1.6
  • org.glassfish.jersey.media:jersey-media-json-jackson:3.1.6
  • org.glassfish.jersey.inject:jersey-hk2:3.1.6
  • com.fasterxml.jackson.jakarta.rs:jackson-jakarta-rs-base:2.14.2
  • com.auth0:java-jwt:3.4.1
  • org.bouncycastle:bcprov-jdk18on:1.78.1
  • com.fasterxml.jackson.dataformat:jackson-dataformat-csv:2.14.2
  • com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.14.2
  • com.brsanthu:migbase64:2.2
  • com.fasterxml.jackson.core:jackson-core:2.17.1
  • org.json:json:20240303

API Reference

You can refer to the API reference here.

Code examples

Explore our GitHub repository for the Launcher, a self-executing package housing code examples for the WebForms Java SDK. This package showcases several common use cases and their respective source files. Additionally, you can download a version preconfigured for your Docusign developer account from Quickstart. These examples support both the Authorization Code Grant and JSON Web Token (JWT) authentication workflows.

OAuth implementations

For details regarding which type of OAuth grant will work best for your Docusign integration, see Choose OAuth Type in the Docusign Developer Center.

For security purposes, Docusign recommends using the Authorization Code Grant flow.

Changelog

You can refer to the complete changelog here.

Support

Log issues against this client SDK through GitHub. You can also reach out to us through Docusign Community and Stack Overflow.

License

The Docusign WebForms Java Client SDK is licensed under the MIT License.

Additional resources