On API Nomenclature
RESTful web APIs are designed around the concept of “resources” and “verbs”:
- Resources are the objects that the user acts upon. They are described as plural nouns.
- Verbs are the actual HTTP verbs, or actions, that are used to manipulate the resources.
Although there are more than thirty HTTP verbs, most of them are never used. For the jSign API, two verbs provide the standard CRUD functionality needed to perform all jSign functions. These verbs are:
| Verb | Description |
|---|---|
| GET | This is the standard HTTP verb that is used in virtually all web browsers. It is used to retrieve one or many existing resources, depending on URI and search parameters. |
| POST | This is the second most commonly used HTTP verb. It is used to create a new instance of a resource. In database terms, this verb is used to insert a new record into the database. |
REST API URL Structure
The REST API URL is constructed as follows: RESTful VERB {{baseUrl}}/api/v2.0/<category>/<resource>
In this structure, baseUrl is the host and the remaining <category>/<resource>is the implementation (the part that actually does something). For example, RESTful VERB {{baseUrl}}/api/v2.0/envelopes/create.
Keep in mind that you never POST to a resource, only to a category. Also, be sure to add an endpoint URL for production and if available, any proof of concept/testing area you may have created.
Sample REST API URLs (Endpoints)
POST '/api/v2.0/templates/upload_file'. This call uploads a new file to create an envelope template.
GET '/api/v2.0/envelopes/eaec5fd0-8b28-4787-ba8b-f9f26ee06711/details'. This call returns the ID of the envelope and its associated metadata (created date, signing due date, status, etc.).
Environments
| Environment | Base URL |
|---|---|
| Sandbox | https://qa-api.jsign.com/api/v2.0 |
| Production | https://api.jsign.com/api/v2.0 |
Specifications
Note: View the jSign API Specifications.
Timezones
Note: The timezone for all responses is UTC (Coordinated Universal Time).