The eSign API allows you to create, manage and send documents for signing via Scrive via an external application. This article aims to help you when you are getting started with the implementation of Scrive in external applications and systems. Below you will find links to relevant articles and resources.
The referenced articles and resources are intended to be used by developers who are implementing the Scrive eSigning service as a third party solution.
If you have any questions that were not covered in the articles, feel free to get in touch with us via email: email@example.com
What do I need?
In order to use the eSign API, you are required to have a license. If you don't have a license already or would like to learn more, click here to get in touch with our sales team. If you already have a license with us and are looking into upgrading get in touch with your customer success manager.
Tools & documentation
eSign API documentation — Technical documentation for our eSign API
eSign testbed environment — Our test environment which is needed when developing your integration. If you don't have access already, you may sign up for a free account directly on the login page.
API-Explorer — Tool for testing the eSign API directly in your browser. This tool allows you to send requests using your own account and inspect the results directly in your web browser.
Navigate to each article below to get started quickly. Each article contains code examples and links to the documentation if needed. The articles below will walk you through how to authenticate, create a document, update the document and send the document for signing.
Before you can begin sending API calls, you are required to be authenticated with your Scrive user. Please see the article below which guides you through the different options such as setting up an OAuth authentication flow or generating personal access credentials.
Once authentication has been set up, you should now be able to send requests. The articles below will walk you through the basic lifecycle of a document where you:
- Create a document
- Update the document
- Send the document
Creating your first document
The first step is to create a new document. These steps are covered in this article:
Updating the document
Before the document can be sent out, you will need to update it with relevant information. This article explains how it is done:
Starting the document
When the preparations are finished, you can now start the document which will make it accessible for the parties. See the article below:
The suggested workflow below is based upon the use of a template document in Scrive, to setup a template. Go to our UI, design the foundation of the process and press "Save template". The document ID will be in the URL after you have pressed save as template.
Migrating from Testbed to Production
Once you have completed the development of your integration you may want to release it to Production. This includes some steps which are described here: