Python Setup

Code samples to help integrating the Signeasy API

Python Setup

For Python, First we need to setup virtual environment with all the dependent libraries which are mentioned in python_requirements.txt . These libraries can be installed using the following command:

pip install -r python_requirements.txt

In main.py the base class SignEasyApi has to be instantiated first with the user api key provided on our website. This object will serve as the base object and it is required while using any of our services.

api_obj = SignEasyApi(api key)

Java Setup

For Java, First we need to setup all the dependent libraries which are mentioned in java_requirements.xml . These libraries can be installed by adding this code to build configuration.

In java_requests.java the base class SignEasyApi has to be instantiated first with the user api key provided on our website. This object will serve as the base object and it is required while using any of our services.

SignEasyApi api_obj = new SignEasyApi(api_key)

NodeJS Setup

For Node, First we need to setup all the dependent libraries which are mentioned in node_requirements.json . These libraries can be installed by adding this code to package.json and executing the command:

npm install

In node_requests.js the base class SignEasyApi has to be instantiated first with the user api key provided on our website. This object will serve as the base object and it is required while using any of our services.

api_obj = new SignEasyApi(api_key)

Note:

From now on we will be using the above mentioned object as api_obj in all the examples.

1- Get all templates

Python

The source code is available in python_sample/main.py.

Sample Example in Python -

# Same declaration would work for both v1 and v2 endpoints

api_obj.get_all_templates()    # This should return json, status code

Java

The source code is available in java_samples/java_requests.java.

Sample Example in Java -

# Same declaration would work for both v1 and v2 endpoints

try{
CloseableHttpResponse resp = api_obj.get_all_templates();}
catch(Exception e){}

Node

The code is available in node_sample/node_requests.js.

Sample Example in Node -

# Same declaration would work for both v1 and v2 endpoints

api_obj.get_all_templates().then((body) =>console.log("success", body)).catch((error) => console.log("error", error))

2- Create Signature request with template

Python

The source code is available in python_sample/payloads/request_signature.py.

Sample Example in Python -

# Same declaration would work for both v1 and v2 endpoints

obj = RequestSignatures(template_file_id=100, recipients=[Recipients(first_name="xyz", email="abc@xyz.com", role_id=1)],
                        is_ordered=False, name="me")                 # These are mandatory fields
obj.recipients.append(Recipients(first_name="def", email="def@xyz.com", role_id=1))
obj.message = "Hello"
obj.cc.append(CC(email=me@xyz.com))
obj.file_password = "dummy"
obj.embedded_signing = True
obj.merge_fields.append(MergeFields(label="signatory", value="me"))

resp, code = obj.create_signature_templates(api_obj.headers, api_obj.base_url)    # This should return json, status code

Java

The source code is available in java_samples/payloads/RequestSignature.java.

Sample Example in Java -

# Same declaration would work for both v1 and v2 endpoints

RequestSignature obj = new RequestSignature(1, "A", false, 
                                            new Recipients(1, "abc@gmail.com", "A"))   # These are mandatory fields
obj.set_message("Hello");
obj.add_cc(new CC("demo@gmail.com"))
obj.set_file_password("dummy")
obj.set_embedded_signing(true)
obj.add_merge_fields(new MergeFields("signatory", "me"))
obj.add_recipients(new Recipients(1, "xyz@gmail.com", "B"))

try{
CloseableHttpResponse resp = obj.create_signature_templates(api_obj.base_url, api_obj.api_token);
catch(Exception e){}

Node

The source code is available in node_sample/payload/RequestSignature.js.

Sample Example in Node -

# Same declaration would work for both v1 and v2 endpoints

rs_obj = new RequestSignature(100, new Recipients(1, "abc@xyz.com", "R"), false, "R")     # These are mandatory fields
rs_obj.add_recipients(new Recipients(1, "def@xyz.com", "R"))
rs_obj.add_cc(new CC("demo@gmail.com"))
rs_obj.add_merge_fields(new MergeFields("signatory", "me"))
rs_obj.message = "Hello"
rs_obj.file_password = "dummy"
rs_obj.embedded_signing = True

rs_obj.create_signature_templates(api_obj.base_url, api_obj.api_token).then((body) =>
console.log("success", body)).catch((error) => console.log("error", error))

3- Fetch embedded sending url

Python

The source code is available in python_sample/payloads/embedded_sending_url.py.

Sample Example in Python -

# Same declaration would work for both v1 and v2 endpoints

obj = SendingUrl(file_id=1245550, recipients=[Recipients(first_name="xyz", email="a.b@c.com", role_id=1)])
obj.recipients.append(Recipients(first_name="def", email="def@xyz.com", role_id=1))
obj.message = "Hello"
obj.cc.append(CC(email=me@xyz.com))
obj.type = "rs"
obj.redirect_url = "abcd/xyz"

resp, code = obj.fetch_embedded_sending_url(api_obj.headers, api_obj.base_url)    # This should return json, status code

Java

The source code is available in java_samples/payloads/SendingUrl.java.

Sample Example in Java -

# Same declaration would work for both v1 and v2 endpoints

SendingUrl obj = new SendingUrl("1245550", new Recipients(1, "a.b@c.com", "A"));
obj.set_message("Hello");
obj.add_cc(new CC("demo@gmail.com"))
obj.set_type("rs")
obj.set_redirect_url("abcd/xyz")
obj.add_recipients(new Recipients(1, "xyz@gmail.com", "B"))

try{
CloseableHttpResponse resp = obj.fetch_embedded_sending_url(api_obj.base_url, api_obj.api_token);
catch(Exception e){}

Node

The source code is available in node_sample/payload/SendingUrl.js.

Sample Example in Node -

# Same declaration would work for both v1 and v2 endpoints

obj = new SendingUrl("1245550", new Recipients(1, "abc@xyz.com", "R"));
obj.add_recipients(new Recipients(1, "def@xyz.com", "R"))
obj.add_cc(new CC("demo@gmail.com"))
rs_obj.message = "Hello"
rs_obj.type = "rs"
rs_obj.redirect_url = "abcd/xyz"

obj.fetch_embedded_sending_url(api_obj.base_url, api_obj.api_token).then((body) =>
console.log("success", body)).catch((error) => console.log("error", error));

4- Upload file

Python

The source code is available in python_sample/payloads/upload_file.py.

Sample Example in Python -

# Same declaration would work for both v1 and v2 endpoints

obj = UploadFile(name="demo.txt", file="/Users/demo/project/api-samples/python_sample/demo.txt")
obj.rename_if_exists = True

resp, code = obj.upload_file(api_obj.headers, api_obj.base_url)    # This should return json, status code

Java

The source code is available in java_samples/payloads/UploadFile.java.

Sample Example in Java -

# Same declaration would work for both v1 and v2 endpoints

UploadFile obj = new UploadFile("demo.txt", "/Users/demo/project/api-samples/python_sample/demo.txt");
obj.rename_flag(true)

try{
CloseableHttpResponse resp = obj.upload_file(api_obj.base_url, api_obj.api_token);
catch(Exception e){}

Node

The source code is available in node_sample/payload/UploadFile.js.

Sample Example in Node -

# Same declaration would work for both v1 and v2 endpoints

obj = new UploadFile("demo.txt", "/Users/demo/project/api-samples/python_sample/demo.txt");
obj.rename_if_exists = true

obj.upload_file(api_obj.base_url, api_obj.api_token).then((body) =>
console.log("success", body)).catch((error) => console.log("error", error));

5- Create a signature request with fields

Python

The source code is available in python_sample/payloads/request_signature_with_fields.py.

Sample Example in Python -

For v1 endpoints:
obj = RequestSignaturesWithFields(original_file_id=38814455,is_ordered=False, name="me",
                                  recipients=[Recipients(first_name="xyz", email="a.b@c.com", role_id=1)],
                                  fields_payload=[FieldsPayload(email="a.b@c.com", type="text", page_number=1,
                                                                x=10, y=10, width=20, height=20)])
obj.recipients.append(Recipients(first_name="def", email="def@xyz.com", role_id=1))
obj.message = "Hello"
obj.cc.append(CC(email=me@xyz.com))
obj.embedded_signing = True
obj.merge_fields.append(MergeFields(label="signatory", value="me"))
obj.fields_payload.append(FieldsPayload(email="x.b@c.com", type="text", page_number=1,x=10, y=10, width=20, height=20))

resp, code = obj.create_signature_request(api_obj.headers, api_obj.base_url)    # This should return json, status code

For v2 endpoints:
obj = RequestSignaturesWithFields(originals=[Originals(id=41038497, name="demofields")], is_ordered=False, name="demo fields",
                                  recipients=[EnvelopeRecipients(first_name="xyz", email="a.b@c.com", recipient_id=1)],
                                  fields_payload=[EnvelopesFieldsPayload(email="a.b@c.com", type="text", page_number=1,
                                                       x=10, y=10, width=20, height=20, recipient_id=1, original_id=1)])

obj.recipients.append(EnvelopeRecipients(first_name="xyz", email="xyz@c.com", recipient_id=2))
obj.message = "Hello"
obj.cc.append(CC(email=me@xyz.com))
obj.embedded_signing = True
obj.merge_fields.append(MergeFields(label="signatory", value="me"))
obj.fields_payload.append(EnvelopesFieldsPayload(email="xyz@c.com", type="text", page_number=1,
                                                 x=10, y=10, width=20, height=20, recipient_id=2, original_id=1))

resp, code = obj.create_signature_request(api_obj.headers, api_obj.base_url)    # This should return json, status code

Java

The source code is available in java_samples/payloads/RequestSignatureWithFields.java.

Sample Example in Java -

For v1 endpoints:
RequestSignatureWithFields obj = new RequestSignatureWithFields(38814455, new Recipients(1, "abc@gmail.com", "abc@gmail.com"),
	                                       false, "a", new FieldsPayload("abc@gmail.com", "text", 1, 10,10, 20,20));
obj.set_message("Hello");
obj.add_cc(new CC("demo@gmail.com"))
obj.set_embedded_signing(true)
obj.add_merge_fields(new MergeFields("signatory", "me"))
obj.add_recipients(new Recipients(1, "xyz@gmail.com", "B"))
obj.add_fields_payload(new FieldsPayload("xyz@gmail.com", "text", 1, 10,10, 20,20))

try{
CloseableHttpResponse resp = obj.create_signature_requests(api_obj.base_url, api_obj.api_token);
catch(Exception e){}

For v2 endpoints:
RequestSignatureWithFields obj = new RequestSignatureWithFields(new Originals("demofields", 41038497), 
                                                                new EnvelopeRecipients(1, "a@b.com", "XYZ"),
        		                                                false, "sample", 
                                                                new EnvelopeFieldsPayload("a@b.com", "text", 1, 10, 10, 20, 20, 1, 1));
obj.set_message("Hello");
obj.add_cc(new CC("demo@gmail.com"))
obj.set_embedded_signing(true)
obj.add_merge_fields(new MergeFields("signatory", "me"))
obj.add_recipients(new EnvelopeRecipients(1, "xyz@gmail.com", "B"))
obj.add_fields_payload(new EnvelopeFieldsPayload("xyz@gmail.com", "text", 1, 10,10, 20,20, 2, 1))

try{
CloseableHttpResponse resp = obj.create_signature_requests(api_obj.base_url, api_obj.api_token);
catch(Exception e){}

Node

The source code is available in node_sample/payload/RequestSignatureWithFields.js.

Sample Example in Node -

For v1 endpoints:
obj = new RequestSignatureWithFields(38814455,  new Recipients(1, "a.b@c.com", "a.b@c.com"),
                                  false, "a", new FieldsPayload("a.b@c.com", "text", 1, 10,10, 20,20));
obj.add_recipients(new Recipients(1, "def@xyz.com", "R"))
obj.add_cc(new CC("demo@gmail.com"))
obj.add_merge_fields(new MergeFields("signatory", "me"))
obj.message = "Hello"
obj.embedded_signing = True
obj.add_fields_payload(new FieldsPayload("a.b@c.com", "text", 1, 10,10, 20,20))

obj.create_signature_requests(api_obj.base_url, api_obj.api_token).then((body) =>
console.log("success", body)).catch((error) => console.log("error", error));

For v2 endpoints:
rs_obj = new RequestSignatureWithFields(new Originals(41038497, "demofields"),
                                        new EnvelopeRecipients(1, "a.b@c.com", "a.b@c.com"),
                                        false, "a", new EnvelopeFieldsPayload("a.b@c.com", "text", 1, 10,10, 20,20, 1, 1));
obj.add_recipients(new EnvelopeRecipients(1, "def@xyz.com", "R"))
obj.add_cc(new CC("demo@gmail.com"))
obj.add_merge_fields(new MergeFields("signatory", "me"))
obj.message = "Hello"
obj.embedded_signing = True
obj.add_fields_payload(new EnvelopeFieldsPayload("a.b@c.com", "text", 1, 10,10, 20,20,2,1))

obj.create_signature_requests(api_obj.base_url, api_obj.api_token).then((body) =>
console.log("success", body)).catch((error) => console.log("error", error));

6- Fetch embedded signing url

Python

The source code is available in python_sample/payloads/embedded_signing_url.py.

Sample Example in Python -

For v1 endpoints:
obj = SigningUrl(id=1234, recipient_email="a.b@c.com")
obj.allow_decline = False
obj.redirect_url = 'abcd/xyz'

resp, code = obj.fetch_embedded_signing_url(api_obj.headers, api_obj.base_url)    # This should return json, status code

For v2 endpoints:
obj = SigningUrl(id=1234, recipient_email="a.b@c.com")
obj.allow_decline = False
obj.redirect_url = 'abcd/xyz'

# To fetch signing url for RS created via embedded sending method
resp, code = obj.fetch_embedded_signing_url_for_embedded_sending(api_obj.headers, api_obj.base_url)    # This should return json, status code

# To fetch signing url for RS created via envelopes
resp, code = obj.fetch_embedded_signing_url_for_envelopes(api_obj.headers, api_obj.base_url)    # This should return json, status code

# To fetch signing url for RS created via templates
resp, code = obj.fetch_embedded_signing_url_for_templates(api_obj.headers, api_obj.base_url)    # This should return json, status code

Java

The source code is available in java_samples/payloads/SigningUrl.java.

Sample Example in Java -

For v1 endpoints:
SigningUrl obj = new SigningUrl(1245550, "abc.cde@gmail.com");
obj.set_allow_decline(false)
oj.set_redirect_url('abcd/xyz')

try{
CloseableHttpResponse resp = obj.fetch_embedded_signing_url(api_obj.base_url, api_obj.api_token);
catch(Exception e){}

For v2 endpoints:
SigningUrl obj = new SigningUrl(1245550, "abc.cde@gmail.com");
obj.set_allow_decline(false)
oj.set_redirect_url('abcd/xyz')

try{
# To fetch signing url for RS created via embedded sending method
CloseableHttpResponse resp = obj.fetch_embedded_signing_url_for_embedded_sending(api_obj.base_url, api_obj.api_token);

# To fetch signing url for RS created via envelopes
CloseableHttpResponse resp = obj.fetch_embedded_signing_url_for_envelopes(api_obj.base_url, api_obj.api_token);

# To fetch signing url for RS created via templates
CloseableHttpResponse resp = obj.fetch_embedded_signing_url_for_templates(api_obj.base_url, api_obj.api_token);
}
catch(Exception e){}

Node

The source code is available in node_sample/payload/SigningUrl.js.

Sample Example in Node -

For v1 endpoints:
obj = new SigningUrl(1249790, "a.b@c.com");
obj.allow_decline = false
obj.redirect_url = 'abcd/xyz'

obj.fetch_embedded_signing_url(api_obj.base_url, api_obj.api_token).then((body) =>
console.log("success", body)).catch((error) => console.log("error", error));

For v2 endpoints:
rs_obj = new SigningUrl(1462202, "abc@xyz.com");
obj.allow_decline = false
obj.redirect_url = 'abcd/xyz'

# To fetch signing url for RS created via embedded sending method
rs_obj.fetch_embedded_signing_url_for_embedded_sending(api_obj.base_url, api_obj.api_token).then((body) =>
console.log("success", body)).catch((error) => console.log("error", error));

# To fetch signing url for RS created via envelopes
rs_obj.fetch_embedded_signing_url_for_envelopes(api_obj.base_url, api_obj.api_token).then((body) =>
console.log("success", body)).catch((error) => console.log("error", error));

# To fetch signing url for RS created via templates
rs_obj.fetch_embedded_signing_url_for_templates(api_obj.base_url, api_obj.api_token).then((body) =>
console.log("success", body)).catch((error) => console.log("error", error));

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

Python Setup

Java Setup

NodeJS Setup

1- Get all templates

Python

Java

Node

2- Create Signature request with template

Python

Java

Node

3- Fetch embedded sending url

Python

Java

Node

4- Upload file

Python

Java

Node

5- Create a signature request with fields

Python

Java

Node

6- Fetch embedded signing url

Python

Java

Node

About

Uh oh!

Releases

Packages

Uh oh!

Contributors 2

Uh oh!

Languages

Name		Name	Last commit message	Last commit date
Latest commit History 33 Commits
v1		v1
v2		v2
.gitignore		.gitignore
README.md		README.md
java_requirements.xml		java_requirements.xml
node_requirements.json		node_requirements.json
python_requirements		python_requirements

signeasy/api-samples

Folders and files

Latest commit

History

Repository files navigation

Python Setup

Java Setup

NodeJS Setup

1- Get all templates

Python

Java

Node

2- Create Signature request with template

Python

Java

Node

3- Fetch embedded sending url

Python

Java

Node

4- Upload file

Python

Java

Node

5- Create a signature request with fields

Python

Java

Node

6- Fetch embedded signing url

Python

Java

Node

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors 2

Uh oh!

Languages

Packages