|
1 | | -# The Official DocuSign Admin Java Client |
| 1 | +# The Official Docusign Admin Java Client SDK |
2 | 2 |
|
3 | 3 | [![Build status][travis-image]][travis-url] |
4 | 4 | [![Maven Central status][maven-image]][maven-url] |
5 | 5 |
|
6 | | -## Requirements |
7 | | - |
8 | | -- Java 1.9+ |
9 | | -- Free [Developer Sandbox](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531) |
10 | | - |
11 | | -## Compatibility |
12 | | - |
13 | | -- Java 1.9+ |
14 | | - |
15 | | -## Note |
| 6 | +The Docusign SDK makes integrating Docusign into your apps and websites a seamless experience. |
| 7 | + |
| 8 | +## Table of Contents |
| 9 | +- [Introduction](#introduction) |
| 10 | +- [Installation](#installation) |
| 11 | + * [Version Information](#versionInformation) |
| 12 | + * [Requirements](#requirements) |
| 13 | + * [Compatibility](#compatibility) |
| 14 | + * [Maven](#maven) |
| 15 | +- [Dependencies](#dependencies) |
| 16 | +- [API Reference](#apiReference) |
| 17 | +- [Code Examples](#codeExamples) |
| 18 | +- [OAuth Implementations](#oauthImplementations) |
| 19 | +- [Changelog](#changeLog) |
| 20 | +- [Support](#support) |
| 21 | +- [License](#license) |
| 22 | +- [Additional Resources](#additionalResources) |
| 23 | + |
| 24 | +<a id="introduction"></a> |
| 25 | +## Introduction |
| 26 | +The Docusign Admin API enables you to automate user management with your existing systems while ensuring governance and compliance. |
| 27 | + |
| 28 | +<a id="installation"></a> |
| 29 | +## Installation |
| 30 | +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](https://developers.docusign.com/docs/admin-api/how-to/) from the [Docusign Developer Center](https://developers.docusign.com/), you merely need to install it by following the instructions below. |
16 | 31 |
|
17 | | -This open-source SDK is provided for cases where you would like to make additional changes that the SDK does not |
18 | | - provide out-of-the-box. If you simply want to use the SDK with any of the examples shown in the [Developer Center ](https://developers.docusign.com/docs/admin-api), follow the installation instructions below. |
| 32 | +<a id="versionInformation"></a> |
| 33 | +### Version Information |
| 34 | +- **API version**: v2.1 |
| 35 | +- **Latest SDK version (Including prerelease)**: |
19 | 36 |
|
20 | | -## Installation |
| 37 | +<a id="requirements"></a> |
| 38 | +## Requirements |
| 39 | +* Java 1.9+ |
| 40 | +* Free [developer account](https://go.docusign.com/o/sandbox/?postActivateUrl=https://developers.docusign.com/) |
21 | 41 |
|
22 | | -Note: DocuSign uses **Eclipse** with **Maven** for testing purposes. |
| 42 | +<a id="compatibility"></a> |
| 43 | +## Compatibility |
| 44 | +* Java 1.9+ |
23 | 45 |
|
| 46 | +<a id="maven"></a> |
| 47 | +**Note:** Docusign uses Eclipse with Maven for testing purposes. |
24 | 48 | ### Maven: |
25 | | - |
26 | | -1. In Eclipse, create a new project by selecting **File** -> **New** -> **Project**. |
27 | | -2. In the **New Project Wizard** , expand **Maven** , then select **Maven Project.** |
| 49 | +1. In Eclipse, create a new project by selecting **File > New > Project**. |
| 50 | +2. In the New Project Wizard, expand **Maven,** then select **Maven Project.** |
28 | 51 | 3. Leave **Create a simple project** unchecked. |
29 | | -4. Select **Next** , then provide a unique **Group** and **Artifact Id**. |
30 | | -5. In the directory where you've saved your project, open the _pom.xml_ file. |
31 | | -6. In the _pom.xml_ file, locate the **dependencies** node. |
32 | | -7. Add: |
33 | | - |
34 | | -``` |
35 | | -<dependency> |
36 | | - <groupId>com.docusign</groupId> |
37 | | - <artifactId>docusign-admin-java</artifactId> |
38 | | - <version>1.1.0</version> |
39 | | -</dependency> |
40 | | -``` |
41 | | - |
42 | | -8. If your project is still open, restart **Eclipse**. |
43 | | - |
44 | | -## Dependencies |
45 | | - |
| 52 | +4. Select **Next,** then provide a unique **groupId** and **artifactId.** |
| 53 | +5. In the directory where you've saved your project, open the pom.xml file. |
| 54 | +6. In the pom.xml file, locate the `dependencies` node. |
| 55 | +7. Add: |
| 56 | + ``` |
| 57 | + <dependency> |
| 58 | + <groupId>com.docusign</groupId> |
| 59 | + <artifactId>docusign-admin-java</artifactId> |
| 60 | + <version>2.0.0-RC1</version> |
| 61 | + </dependency> |
| 62 | + ``` |
| 63 | +8. If your project is still open, restart Eclipse. |
| 64 | +
|
| 65 | +<a id="dependencies"></a> |
| 66 | +## SDK Dependencies |
46 | 67 | This client has the following external dependencies: |
47 | | - |
48 | | -- io.swagger:swagger-annotations:jar:1.5.17 |
49 | | -- org.glassfish.jersey.core:jersey-client:jar:2.29.1 |
50 | | -- org.glassfish.jersey.media:jersey-media-multipart:jar:2.29.1 |
51 | | -- org.glassfish.jersey.media:jersey-media-json-jackson:2.29.1 |
52 | | -- com.fasterxml.jackson.core:jackson-core:jar:2.10.1 |
53 | | -- com.fasterxml.jackson.core:jackson-annotations:jar:2.10.1 |
54 | | -- com.fasterxml.jackson.core:jackson-databind:2.10.1 |
55 | | -- junit:junit:jar:4.12 |
56 | | -- com.apache.oltu.oauth2:org.apache.oltu.oauth2.client:1.0.2 |
57 | | -- com.auth0:java-jwt:3.4.1 |
58 | | -- org.bouncycastle:bcprov-jdk15on:1.60 |
59 | | - |
60 | | -## OAuth Implementations |
61 | | - |
62 | | -For details regarding which type of OAuth grant will work best for your DocuSign integration, see the [REST API |
63 | | - Authentication Overview](https://developers.docusign.com/docs/admin-api/admin101/auth/) guide located on the [DocuSign Developer Center](https://developers.docusign.com/). |
64 | | - |
65 | | -For security purposes, DocuSign recommends using the Authorization Code Grant flow. |
66 | | - |
| 68 | +* io.swagger.core.v3:swagger-annotations:2.2.8 |
| 69 | +* org.glassfish.jersey.core:jersey-client:3.1.6 |
| 70 | +* org.glassfish.jersey.media:jersey-media-multipart:3.1.6 |
| 71 | +* org.glassfish.jersey.media:jersey-media-json-jackson:3.1.6 |
| 72 | +* org.glassfish.jersey.inject:jersey-hk2:3.1.6 |
| 73 | +* com.fasterxml.jackson.jakarta.rs:jackson-jakarta-rs-base:2.14.2 |
| 74 | +* com.auth0:java-jwt:3.4.1 |
| 75 | +* org.bouncycastle:bcprov-jdk18on:1.78.1 |
| 76 | +* com.fasterxml.jackson.dataformat:jackson-dataformat-csv:2.14.2 |
| 77 | +* com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.14.2 |
| 78 | +* com.brsanthu:migbase64:2.2 |
| 79 | +* com.fasterxml.jackson.core:jackson-core:2.17.1 |
| 80 | +* org.json:json:20240303 |
| 81 | +
|
| 82 | +
|
| 83 | +<a id="apiReference"></a> |
| 84 | +## API Reference |
| 85 | +You can refer to the API reference [here](https://developers.docusign.com/docs/admin-api/reference/). |
| 86 | +
|
| 87 | +<a id="codeExamples"></a> |
| 88 | +## Code examples |
| 89 | +Explore our GitHub repository for the [Launcher](https://github.com/docusign/code-examples-java/), a self-executing package housing code examples for the Admin 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](https://developers.docusign.com/docs/esign-rest-api/quickstart/). These examples support both the [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) and [JSON Web Token (JWT)](https://developers.docusign.com/platform/auth/jwt/) authentication workflows. |
| 90 | +
|
| 91 | +<a id="oauthImplementations"></a> |
| 92 | +## OAuth implementations |
| 93 | +For details regarding which type of OAuth grant will work best for your Docusign integration, see [Choose OAuth Type](https://developers.docusign.com/platform/auth/choose/) in the [Docusign Developer Center](https://developers.docusign.com/). |
| 94 | +
|
| 95 | +For security purposes, Docusign recommends using the [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) flow. |
| 96 | +
|
| 97 | +<a id="changeLog"></a> |
| 98 | +## Changelog |
| 99 | +You can refer to the complete changelog [here](https://github.com/docusign/docusign-admin-java-client/blob/master/CHANGELOG.md). |
| 100 | +
|
| 101 | +<a id="support"></a> |
67 | 102 | ## Support |
| 103 | +Log issues against this client SDK through GitHub. You can also reach out to us through [Docusign Community](https://community.docusign.com/developer-59) and [Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi). |
68 | 104 |
|
69 | | -Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi). |
70 | | - |
| 105 | +<a id="license"></a> |
71 | 106 | ## License |
| 107 | +The Docusign Admin Java Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-admin-java-client/blob/master/LICENSE). |
72 | 108 |
|
73 | | -The DocuSign Java Client is licensed under the [MIT License](https://github.com/docusign/docusign-admin-java-client/blob |
74 | | -/master/LICENSE). |
75 | | - |
| 109 | +<a id="additionalResources"></a> |
| 110 | +### Additional resources |
| 111 | +* [Docusign Developer Center](https://developers.docusign.com/) |
| 112 | +* [Docusign API on Twitter](https://twitter.com/docusignapi) |
| 113 | +* [Docusign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/) |
| 114 | +* [Docusign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ) |
76 | 115 |
|
77 | 116 | [travis-image]: https://api.travis-ci.com/docusign/docusign-admin-java-client.svg?branch=master |
78 | 117 | [travis-url]: https://app.travis-ci.com/github/docusign/docusign-admin-java-client |
79 | | -[maven-image]: https://img.shields.io/maven-central/v/com.docusign/docusign-admin-java.svg?style=flat |
| 118 | +[maven-image]: https://img.shields.io/maven-central/v/com.docusign/.svg?style=flat |
80 | 119 | [maven-url]: https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.docusign%22 |
81 | | - |
82 | | -### Additional Resources |
83 | | -* [DocuSign Developer Center](https://developers.docusign.com) |
84 | | -* [DocuSign API on Twitter](https://twitter.com/docusignapi) |
85 | | -* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/) |
86 | | -* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ) |
|
0 commit comments