Java Migration Guide

1
<dependency>
2
  <groupId>com.dropbox.sign</groupId>
3
  <artifactId>dropbox-sign</artifactId>
4
  <version>2.x.x-</version>
5
</dependency>

1
import com.hellosign.sdk;

1
HelloSignClient client = new HelloSignClient(apiKey);

1
var signer1 = new SubSignatureRequestSigner()
2
    .emailAddress("jack@example.com")
3
    .name("Jack")
4
    .order(0);
5
6
var attachment1 = new SubAttachment()
7
    .name("Attachment 1")
8
    .instructions("Please download this file")
9
    .signerIndex(0)
10
    .required(true);

1
FormField signature1 = new FormField();
2
field.setX(100);
3
field.setY(100);
4
field.setType(FieldType.valueOf("signature"));
5
field.setSigner(1);
6
field.setPage(1);
7
field.setApiId("1234");
8
field.setHeight(10);
9
field.setWidth(20);
10
field.setIsRequired(true);
11
SignatureRequest request = new SignatureRequest();
12
Document doc = new Document();
13
doc.addFormField(signature1);

1
var formField1 = SubFormFieldsPerDocumentSignature.init(new HashMap<>()  {{
2
    put("document_index", 0);
3
    put("api_id", "4688957689");
4
    put("name", "signature1");
5
    put("x", 5);
6
    put("y", 7);
7
    put("width", 60);
8
    put("height", 30);
9
    put("required", true);
10
    put("signer", 0);
11
    put("page", 1);
12
}});

1
{
2
  "signers": {
3
    "Client": {
4
      "name": "George",
5
      "email_address": "george@example.com"
6
    },
7
    "Manager": {
8
      "name": "Bob",
9
      "email_address": "bob@example.com"
10
    }
11
  }
12
}

1
import com.dropbox.sign.ApiException;
2
import com.dropbox.sign.Configuration;
3
import com.dropbox.sign.api.*;
4
import com.dropbox.sign.auth.*;
5
import com.dropbox.sign.model.*;
6
7
import java.util.HashMap;
8
import java.util.List;
9
10
public class Example {
11
    public static void main(String[] args) throws Exception {
12
        var apiClient = Configuration.getDefaultApiClient()
13
            .setApiKey("YOUR_API_KEY");
14
15
        var signatureRequestApi = new SignatureRequestApi(apiClient);
16
17
        var data = new SignatureRequestSendWithTemplateRequest()
18
            .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6"))
19
            .subject("Purchase Order")
20
            .message("Glad we could come to an agreement.")
21
            .signers(List.of(
22
                SubSignatureRequestTemplateSigner.init(new HashMap<>()  {{
23
                    put("role", "Client");
24
                    put("name", "George");
25
                    put("email_address", "george@example.com");
26
                }}),
27
                SubSignatureRequestTemplateSigner.init(new HashMap<>()  {{
28
                    put("role", "Manager");
29
                    put("name", "Bob");
30
                    put("email_address", "bob@example.com");
31
                }})
32
            ));
33
34
        try {
35
            SignatureRequestGetResponse result = signatureRequestApi.signatureRequestSendWithTemplate(data);
36
            System.out.println(result);
37
        } catch (ApiException e) {
38
            System.err.println("Exception when calling AccountApi#accountCreate");
39
            System.err.println("Status code: " + e.getCode());
40
            System.err.println("Reason: " + e.getResponseBody());
41
            System.err.println("Response headers: " + e.getResponseHeaders());
42
            e.printStackTrace();
43
        }
44
    }
45
}

1
{
2
  "ccs": {
3
    "Client": "george@example.com",
4
    "Manager": "bob@example.com"
5
  }
6
}

1
import com.dropbox.sign.ApiException;
2
import com.dropbox.sign.Configuration;
3
import com.dropbox.sign.api.*;
4
import com.dropbox.sign.auth.*;
5
import com.dropbox.sign.model.*;
6
7
import java.util.HashMap;
8
import java.util.List;
9
10
public class Example {
11
    public static void main(String[] args) throws Exception {
12
        var apiClient = Configuration.getDefaultApiClient()
13
            .setApiKey("YOUR_API_KEY");
14
15
        var signatureRequestApi = new SignatureRequestApi(apiClient);
16
17
        var data = new SignatureRequestSendWithTemplateRequest()
18
            .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6"))
19
            .subject("Purchase Order")
20
            .message("Glad we could come to an agreement.")
21
            .signers(List.of(
22
                SubSignatureRequestTemplateSigner.init(new HashMap<>()  {{
23
                    put("role", "Client");
24
                    put("name", "George");
25
                    put("email_address", "george@example.com");
26
                }}),
27
                SubSignatureRequestTemplateSigner.init(new HashMap<>()  {{
28
                    put("role", "Manager");
29
                    put("name", "Bob");
30
                    put("email_address", "bob@example.com");
31
                }})
32
            ))
33
            .ccs(List.of(
34
                SubCC.init(new HashMap<>()  {{
35
                    put("role", "Client");
36
                    put("email_address", "george@example.com");
37
                }}),
38
                SubCC.init(new HashMap<>()  {{
39
                    put("role", "Manager");
40
                    put("email_address", "bob@example.com");
41
                }})
42
            ));
43
44
        try {
45
            SignatureRequestGetResponse result = signatureRequestApi.signatureRequestSendWithTemplate(data);
46
            System.out.println(result);
47
        } catch (ApiException e) {
48
            System.err.println("Exception when calling AccountApi#accountCreate");
49
            System.err.println("Status code: " + e.getCode());
50
            System.err.println("Reason: " + e.getResponseBody());
51
            System.err.println("Response headers: " + e.getResponseHeaders());
52
            e.printStackTrace();
53
        }
54
    }
55
}

1
{
2
  "custom_fields": {
3
    "company": {
4
      "value": "ABC Corp",
5
      "required": true
6
    }
7
  }
8
}

1
import com.dropbox.sign.ApiException;
2
import com.dropbox.sign.Configuration;
3
import com.dropbox.sign.api.*;
4
import com.dropbox.sign.auth.*;
5
import com.dropbox.sign.model.*;
6
7
import java.util.HashMap;
8
import java.util.List;
9
10
public class Example {
11
    public static void main(String[] args) throws Exception {
12
        var apiClient = Configuration.getDefaultApiClient()
13
            .setApiKey("YOUR_API_KEY");
14
15
        var signatureRequestApi = new SignatureRequestApi(apiClient);
16
17
        var data = new SignatureRequestSendWithTemplateRequest()
18
            .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6"))
19
            .subject("Purchase Order")
20
            .message("Glad we could come to an agreement.")
21
            .signers(List.of(
22
                SubSignatureRequestTemplateSigner.init(new HashMap<>()  {{
23
                    put("role", "Client");
24
                    put("name", "George");
25
                    put("email_address", "george@example.com");
26
                }}),
27
                SubSignatureRequestTemplateSigner.init(new HashMap<>()  {{
28
                    put("role", "Manager");
29
                    put("name", "Bob");
30
                    put("email_address", "bob@example.com");
31
                }})
32
            ))
33
            .customFields(List.of(
34
                SubCustomField.init(new HashMap<>()  {{
35
                    put("name", "company");
36
                    put("value", "ABC Corp");
37
                    put("required", true);
38
                }})
39
            ));
40
41
        try {
42
            SignatureRequestGetResponse result = signatureRequestApi.signatureRequestSendWithTemplate(data);
43
            System.out.println(result);
44
        } catch (ApiException e) {
45
            System.err.println("Exception when calling AccountApi#accountCreate");
46
            System.err.println("Status code: " + e.getCode());
47
            System.err.println("Reason: " + e.getResponseBody());
48
            System.err.println("Response headers: " + e.getResponseHeaders());
49
            e.printStackTrace();
50
        }
51
    }
52
}

1
//Using the Document Class
2
Document doc1 = new Document();
3
doc1.setFile(new File("/NDA.pdf"));

1
import com.dropbox.sign.ApiException;
2
import com.dropbox.sign.Configuration;
3
import com.dropbox.sign.api.*;
4
import com.dropbox.sign.auth.*;
5
6
import java.io.File;
7
8
public class Example {
9
    public static void main(String[] args) {
10
        var apiClient = Configuration.getDefaultApiClient()
11
            .setApiKey("YOUR_API_KEY");
12
13
        var signatureRequestApi = new SignatureRequestApi(apiClient);
14
15
        var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967";
16
17
        try {
18
            File result = signatureRequestApi.signatureRequestFiles(signatureRequestId, "pdf");
19
            result.renameTo(new File("file_response.pdf"));
20
        } catch (ApiException e) {
21
            System.err.println("Exception when calling AccountApi#accountCreate");
22
            System.err.println("Status code: " + e.getCode());
23
            System.err.println("Reason: " + e.getResponseBody());
24
            System.err.println("Response headers: " + e.getResponseHeaders());
25
            e.printStackTrace();
26
        }
27
    }
28
}

1
import com.dropbox.sign.ApiException;
2
import com.dropbox.sign.Configuration;
3
import com.dropbox.sign.api.*;
4
import com.dropbox.sign.auth.*;
5
6
import java.io.File;
7
8
public class Example {
9
    public static void main(String[] args) {
10
        var apiClient = Configuration.getDefaultApiClient()
11
            .setApiKey("YOUR_API_KEY");
12
13
        var templateApi = new TemplateApi(apiClient);
14
15
        var templateId = "f57db65d3f933b5316d398057a36176831451a35";
16
17
        try {
18
            File result = templateApi.templateFiles(templateId, "pdf");
19
            result.renameTo(new File("file_response.pdf"));
20
        } catch (ApiException e) {
21
            System.err.println("Exception when calling AccountApi#accountCreate");
22
            System.err.println("Status code: " + e.getCode());
23
            System.err.println("Reason: " + e.getResponseBody());
24
            System.err.println("Response headers: " + e.getResponseHeaders());
25
            e.printStackTrace();
26
        }
27
    }
28
}

1
SignatureRequest request = new SignatureRequest();
2
request.setSubject("NDA");
3
request.setMessage("Hi Jack, Please sign this NDA and let's discuss.");
4
request.addSigner("jack@example.com", "Jack");
5
request.addFile(new File("path_to/myfile.pdf"));
6
SignatureRequest response = client.sendSignatureRequest(request);
7
System.out.println(response.toString());

1
SignatureRequest request = new SignatureRequest();
2
request.setTitle("NDA with Acme Co.");
3
request.setSubject("The NDA we talked about");
4
request.setMessage("Please sign this NDA and then we can discuss more.");
5
request.addSigner("jack@example.com", "Jack");
6
request.addSigner("jill@example.com", "Jill");
7
request.addCC("lawyer@dropboxsign.com");
8
request.addCC("lawyer@example.com");
9
request.addFile(new File("nda.pdf"));
10
request.addFile(new File("AppendixA.pdf"));
11
request.setTestMode(true);
12
13
String clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a";
14
EmbeddedRequest embedReq = new EmbeddedRequest(clientId, request);
15
16
HelloSignClient client = new HelloSignClient("API Key");
17
SignatureRequest newRequest = (SignatureRequest) client.createEmbeddedRequest(embedReq);

1
TemplateSignatureRequest request = new TemplateSignatureRequest();
2
request.setTemplateId("c26b8a16784a872da37ea946b9ddec7c1e11dff6");
3
request.setSubject("Purchase Order");
4
request.setMessage("Glad we could come to an agreement.");
5
request.setSigner("Client", "george@example.com", "George");
6
request.setCC("Accounting", "accounting@dropboxsign.com");
7
request.setCustomFieldValue("Cost", "$20,000");
8
request.setTestMode(true);
9
10
HelloSignClient client = new HelloSignClient("API_KEY");
11
SignatureRequest newRequest = client.sendTemplateSignatureRequest(request);

1
HelloSignClient client = new HelloSignClient("API_KEY");
2
String signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f";
3
File zippedFiles = client.getFiles(signatureRequestId, SignatureRequest.SIGREQ_FORMAT_ZIP);

1
HelloSignClient client = new HelloSignClient("API_KEY");
2
String signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967";
3
SignatureRequest request = client.getSignatureRequest(signatureRequestId);

1
HelloSignClient client = new HelloSignClient("API_KEY");
2
SignatureRequestList list = client.getSignatureRequests(1);

1
SignatureRequest sigReq = new SignatureRequest();
2
sigReq.setTestMode(true);
3
sigReq.addFile(new File("NDA.pdf"));
4
5
UnclaimedDraft draft = new UnclaimedDraft(sigReq, UnclaimedDraftType.request_signature);
6
draft.setIsForEmbeddedSigning(false);
7
draft.setRequesterEmail("jack@dropboxsign.com");
8
9
String clientId = "ca1209bc08912a8a881234def21352ab";
10
EmbeddedRequest embedReq = new EmbeddedRequest(clientId, draft);
11
12
HelloSignClient client = new HelloSignClient("API_KEY");
13
UnclaimedDraft responseDraft = (UnclaimedDraft) client.createEmbeddedRequest(embedReq);

1
TemplateDraft draft = new TemplateDraft();
2
draft.setTestMode(true);
3
draft.setTitle("NDA Template");
4
draft.addSignerRole("Client");
5
draft.addCCRole("Lawyer");
6
draft.addFile(getTestFile("nda.pdf"));
7
8
EmbeddedRequest eReq = new EmbeddedRequest(clientId, draft);
9
HelloSignClient client = new HelloSignClient("API_KEY");
10
TemplateDraft t = client.createEmbeddedTemplateDraft(eReq);

1
ApiApp app = new ApiApp();
2
3
WhiteLabelingOptions wl= new WhiteLabelingOptions();
4
wl.setPrimaryButtonHoverColor("#4B1414");
5
wl.setHeaderBackgroundColor("#171616");
6
7
app.setWhiteLabelingOptions(wl);
8
app.setDomain("www.example.com");
9
app.setName("Test API App");
10
app.getClientId();
11
12
client.createApiApp(app);