Fair API Pricing
No Surprise Fees
Secure Your Document Distribution and Management with a Signority API Plan
Getting Started
Quickstart
Download the Python sample code here.
To run the Python sample code requires:
- requests library
- pprint library
Download the Java Sample Code here.
1. Within the .classpath file, change the following line:
<classpathentry kind=”lib” path=”<LOCATION>/Signority_API_JAVA/src/gson-2.8.5.jar”>
So that the <LOCATION> is the location that the project is located
2. Makes sure that the GSON jar is located in the src folder of the project, if not found, download the latest version and place the gson-X.X.X.jar in the src folder
Download the C# sample code here.
Curl setup coming soon
JS setup
Testing
Signority offers a testing suite for APIs with a base request URL of:
https://test.signority.com/api
Most of the request endpoints listed in our reference are accessible through the testing server. Note that documents signed on the test server are not legally binding.
Click here to download the Postman tests
Sandbox
Signority offers a sandbox environment for APIs with a base request URL of:
https://sandbox.signority.com/api
Most of the request endpoints listed in our reference are accessible through the sandbox server. Note that documents signed on the sandbox server are not legally binding.
Authentication
The Signority API primarily uses basic authentication to distinguish the users when processing the API requests. Authentication data is securely encrypted using SSL.
Basic Authentication
Use the email address and password that you used for your Signority account. You can also use your API key as the user name and leave the password field empty. Your API key can be found under My Account –> Profile Settings –> Integration.
1. Using email or password
curl 'https://sign.signority.com/api/v1/user/login' \
-u '{YOUR EMAIL ADDRESS}:{YOUR PASSWORD}'
2. Using API Key
curl 'https://sign.signority.com/api/v1/user/login' \
-u '{YOUR API KEY}:'
1. Using email and password:
requests."REQUEST_TYPE"("URL", auth=("EMAIL", "PASSWORD"))
or
Create a header with:header =
{
'email'="EMAIL"
'password'="PASSWORD"
}
2. Using API key:
requests."REQUEST_TYPE"("URL", auth=("API_KEY", ""))
or
Create a header with:header =
{
'email'="API_KEY"
'password'=""
}
Java authentication
C# authentication
JavaScript authentication coming soon
Signority allows you to define the range of IP addresses authorized to access Signority’s API using your credentials. This optional IP white list is not enabled by default.
To restrict what IPs can access Signority’s API based on a specific list or range of IP addresses, follow these steps.
- Log in to the Signority web interface and click “My Account” > “Profile Settings” > “Integration”.
- Check “Enable API White Label” to enable the feature.
- In the IP field enter the IP addresses you wish to allow to access the API to your account should be restricted.
- Click the Save button.
To disable IP white listing on your Signority account and allow the API access to any IP range, follow these steps.
- Log in to the Signority web interface and click “My Account” > “Profile Settings” > “Integration”.
- Uncheck “Enable API White Label”.
- Click the Save button.