signnow / signnowjavaapiclient

The Official SignNow Java Client Library for interacting with SignNow REST API. Sign documents, request e-signatures, and build role-based workflows with multiple signers using this client. https://www.signnow.com/developers

About SignNow

SignNow allows you to embed legally-binding e-signatures into your app, CRM or cloud storage. Send documents for signature directly from your website. Invite multiple signers to finalize contracts. Track status of your requests and download signed copies automatically.

This is a two module application which consists of the client-lib library and the example-app module. The client-lib library is used to interact with SignNow API. It covers all the authentication routines, request building and provides simple DTO objects to use in your applications. The second module, example-app, is a Spring Boot application which contains implementation examples of SignNow API use-cases.

Get your account at https://www.signnow.com/developers

API and Application

Resources	Sandbox	Production
API:	api-eval.signnow.com:443	api.signnow.com:443
Application:	https://app-eval.signnow.com	https://app.signnow.com
Entry page:	https://eval.signnow.com

Contents

• Documentation
• Get started
• Examples
• Contribution guidelines
• License

Documentation

Read about the available SignNow features in SignNow API Docs .

Get started

To start using the API you have to create a SignNow account here

Make sure you have Maven installed. Checkout this repo, cd into repo root directory and run:

mvn clean install -pl client-lib

This will add client lib into your local Maven repo. Next, add a dependency to your app pom file:

<dependency>
    <groupId>com.signnow</groupId>
    <artifactId>api-client-lib</artifactId>
    <version>1.0.0-SNAPSHOT</version>
</dependency>   

In your code get SN API client instance by calling the next method with corresponding parameters:

SNClientBuilder.get("apiUrl", "clientId", "clientSecret");

If you'd like to run an example application - set parameters named in the \example-app\src\main\resources\application.properties Feel free to try the provided examples and explore the corresponding code.

Examples

To run the examples you will need an API key. You can get one here https://www.signnow.com/api. For a full list of accepted parameters, refer to the SignNow REST Endpoints API guide: https://docs.signnow.com/reference.

Note: In the following examples we've listed only the common use-cases but this list shouldn't limit your requests. The client library provides an all-purpose wrapper and DTO objects for any API call to SignNow. Feel free to use any method from the client library.

User:

• Login

Document

• Retrieve a List of the User’s Documents
• Upload document
• Upload File & Extract Fields
• Update Document (add prefilled fields)
• Update Document (add fields)
• Create Free Form Invite

Links

• Create signing link

Template

• Create a Template
• Create Invite to Sign a Template for multiple signers
• Create Invite to Sign multiple Templates for multiple signers

Contribution guidelines

Many thanks to all the contributors who got interested in this project. We're excited to hear from you. Here are some tips to make our collaboration meaningful and bring its best results to life:

• We accept pull requests from the community. Please, send your pull requests to the DEVELOP branch which is the consolidated work-in-progress branch. We don't accept requests to the Master branch.

• Please, check in with the documentation first before you open a new Issue.

• When suggesting new functionality, give as many details as possible. Add a test or code example if you can.

• When reporting a bug, please, provide full system information. If possible, add a test that helps us reproduce the bug. It will speed up the fix significantly.

License

This SDK is distributed under the MIT License, see LICENSE for more information.

API Contact Information

If you have questions about the SignNow API, please visit https://docs.signnow.com or email [email protected].
Support: To contact SignNow support, please email [email protected] or [email protected].
Sales: For pricing information, please call [phone], email [email protected] or visit https://www.signnow.com/contact.

signnowjavaapiclient's Issues

Gradle fails

Maven Central

Could you add this to Maven central? Having to install into local maven repo makes my build much more difficult for other developers.