Get started with the Web Forms API
The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact Docusign Support or your account manager to find out whether the Web Forms API is available for your production account plan.
To start making Web Forms API calls, you need:
- A free Docusign developer account.
- An app and integration key in the developer environment. The integration key, sometimes referred to as a client ID, and the settings associated with it are required to authenticate with the Docusign platform so that you can make API requests. See Configure your app for details about how to set up an app and integration key. If you run Web Forms API examples from Quickstart, the tool automatically sets up an app and integration key in your developer account.
- A web form configuration in your developer account. A web form configuration defines the content and behavior of a web form and must be created and activated using the Web Forms builder. To access it, log in to the eSignature web application, select Templates from the top navigation, select the Start button in the left navigation, then select Web Forms > Create Web Form. If you run Web Forms API examples from Quickstart or the code example launchers, you will receive instructions for creating and activating a web form configuration from a JSON file that these tools automatically generate.
Developer tools
These tools provide sample code to help you start making Web Forms API calls:
- Quickstart provides executable Web Forms API code examples in Bash, C#, Java, Node.js, PHP, PowerShell, Python, and Ruby that run under an app and integration key that Quickstart automatically creates in your developer account.
- Code example launchers offer the same code examples as Quickstart, but they require manual configuration for authentication. Instructions are provided in each code launcher’s README file.
- The Web Forms API Postman collection is a library of API requests that you can execute.
- API Explorer enables you to send test requests from the API reference method pages and review the responses without authenticating or configuring a project.
- The Web Forms Sample App sample app provides a demo that you can run without installing or building a project. You can also download the source code, written in C# and React.js, to run it locally and use it to start building your own integrations.
Next steps
- See Plan a Web Forms API integration for an overview of the implementation details that you should consider before starting work on your application.
- See Endpoint base path for information about constructing API endpoint URLs.
- See the API reference for a complete list of Web Forms API endpoints and their paths.