API Concepts
Welcome to the eSign360 API help section! This guide will introduce you to the core concepts of the eSign360 API, helping you understand the basics and get started on the right foot. The eSign360 API enables you to access and manage various resources related to your account, such as users and eSignatures.
API Base URL
The base URL for all API requests depends on the environment:
| Environment | Base URL |
|---|---|
| Production | https://public-api.esign360.io |
| Development | https://public-api.dev.notary.sh |
Each endpoint's path should be appended to the appropriate base URL to form the complete request URL. For example, to list users in production:
GET https://public-api.esign360.io/users
Authentication
The eSign360 API uses token-based authentication (Bearer Token) to ensure that only authorized users can access the eSign360 API resources. You will need to obtain an API access token from your account to authenticate your API requests.
Include the access token in the Authorization header of your requests, like so:
Authorization: Bearer `<accessToken>`
Replace <accessToken> with your actual API access token.
Request Methods and Endpoints
The eSign360 API uses standard HTTP methods (such as GET, POST, PUT, PATCH, and DELETE) to perform various operations on resources. Each operation is associated with a specific endpoint.
For example, to retrieve a list of users in your organization, you would send a GET request to the /users endpoint.
Data Formats
The eSign360 API uses JSON as the primary data format for request and response bodies. When making a request, make sure to set the Content-Type header to application/json.
Pagination
When retrieving lists of resources (such as users or transactions), the eSign360 API may return paginated results to prevent overwhelming the client with large amounts of data. Use query parameters like limit, offset, and page to control the pagination of results.
Error Handling
If there's an error while processing your API request, the eSign360 API will return an HTTP status code indicating the error type, along with a JSON object that provides more details about the error.
Rate Limiting
The eSign360 API enforces rate limits to prevent abuse and ensure fair usage. If you exceed the rate limit, the eSign360 API will return a 429 Too Many Requests status code. You should implement a retry mechanism with exponential backoff in your client to handle rate-limited requests.
Additional Resources
For more information about the eSignature API, visit the official documentation.
If you need further assistance or have questions, feel free to reach out to our support team.