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
{{ message }}
This repository was archived by the owner on Oct 17, 2023. It is now read-only.
Use the `hellosign-java-sdk` to get your Java app connected to HelloSign's API in minutes.
4
+
Get your Java app connected to HelloSign's API in jiffy.
7
5
8
6
## Installing
9
7
10
-
The SDK is built and deployed to the[Central Maven repository](https://repo1.maven.org/maven2/com/hellosign/hellosign-java-sdk/). Add it to your Maven project by including the following `<dependency>` in your `pom.xml`:
8
+
SDK releases are published to Maven's[Central repository](https://repo1.maven.org/maven2/com/hellosign/hellosign-java-sdk/):
11
9
12
10
```xml
13
11
<dependency>
@@ -18,24 +16,22 @@ The SDK is built and deployed to the [Central Maven repository](https://repo1.ma
18
16
</dependency>
19
17
```
20
18
21
-
> NOTE: It is compiled with and targeted for Java 7 and depends on the [SL4J 1.7.5](http://www.slf4j.org/) and JSON v20090211 libraries. If your project already includes these, use the JAR without dependencies by removing the `<classifier>` element in the example above.
22
-
23
19
Alternatively, you can build the JAR yourself:
24
20
25
-
mvn clean package -DskipTests
21
+
mvn clean package
26
22
27
-
Locate the JAR file in the `target` directory and place it on your project classpath.
23
+
Place `target/hellosign-java-sdk-<VERSION>.jar` on your project classpath.
28
24
29
25
## Usage
30
26
31
-
All HelloSign API requests are made using the `HelloSignClient`. This class must be initialized with your [API key](https://www.hellosign.com/home/myAccount/current_tab/integrations#api).
27
+
First initialize an instance of the `HelloSignClient` with your [API key](https://www.hellosign.com/home/myAccount/current_tab/integrations#api):
The following examples assume the client has been initialized this way.
36
32
37
33
### Create a Signature Request
38
-
Construct a `SignatureRequest` object and populate it with request details. When you provide this object to the `HelloSignClient.sendSignatureRequest()` method, an HTTP request will be made and the method will return a `SignatureRequest` object. Use this object to read details about the new signature request.
The HelloSign API provides paged lists of templates and signature requests (`client.getSignatureRequests()`). These lists are represented as objects that can be iterated upon:
<!-- We've also built a sample J2EE application that demonstrates how to use the SDK for creating requests, working with embedded flows, and handling callback events:
0 commit comments