DocuSign just released two new tools for developers: An all new API Explorer along with new, modern API Documentation. Both tools are significant improvements over their predecessors and will help developers integrate DocuSign into their apps or websites in minutes.
New API Explorer (BETA)
The new API Explorer (BETA), hereafter referred to as just API Explorer, lets developers test our REST API without writing any code – giving you instant insight into our APIs and platform. This streamlines the development of your apps since it lets you test and verify your calls, parameters, and responses received from the server. The API Explorer also enables you to troubleshoot technical issues in the applications you build. Note that the API Explorer makes calls in the DocuSign Demo environment.
You can try the new API Explorer here: https://apiexplorer.docusign.com. Note that it is generated using Swagger, which helps ensure that as we add functionality to our platform, the API Explorer is automatically updated as well.
To begin, you’ll need to authenticate with your developer/sandbox account credentials. Enter your email, password, and integrator key, then click the AUTHENTICATE USING SANDBOX ACCOUNT button, as shown in Figure 1.
Note: If you need to look up your integrator key or account ID, simply log into the Developer Center Sandbox, click the down arrow next to your profile picture on the top right, and click Go to Admin. After you are in the Admin Console, click API and Keys and you’ll see your integrator key.
Figure 1: Entering your Developer Account Credentials in the API Explorer.
If your login is successful, you’ll see a status message at the top of the screen with a green background, similar to the one shown in Figure 2.
Figure 2: Successful Authentication.
You are now able to begin using the API Explorer. You’ll notice a left-hand navigation pane, divided into two separate sections, which are shown in Figure 3.
Figure 3: API Explorer Navigation Pane.
The top section lists the method categories that are frequently used. The bottom section lists every API method available and groups them into categories. To navigate deeper into the structure, simply click the arrow to expand the corresponding selection.
If you navigate to a specific method, you’ll see the parameters that can be specified or selected. Enter the desired parameters for your selected method and click SEND REQUEST. You’ll see the API request, response, and any error messages. This will help you to understand the response structure that you will handle in your code.
Modern API Documentation
We’ve completely re-done our API Docs, giving them a more modern look and feel while adding new functionality as well.
You can see our new API documentation here: https://docs.docusign.com.
Our new API documentation follows a Resource-based representation of our REST API, which is a new and emerging way of documenting APIs. Additionally the new documentation is generated using Swagger, which helps ensure that as we add functionality to our platform, the documentation is automatically updated as well.
After you open the API documentation, you’ll notice in Figure 4 that it is divided into several sections in the left-hand navigation pane.
Figure 4: New API Documentation.
At the top is a USAGE section, which contains links for a great overview into how to use the REST API. Next is the AUTHENTICATION section, which contains links to everything you need to know about security and authentication for the REST API. The third section, REST API REFERENCE, is a complete reference to all REST API resources and methods. Each method shows complete documentation for all verbs, request and response signatures, argument definitions, datatypes, and examples. The fourth section is an APPENDIX, which contains a glossary, error codes, and more. Finally, the left-hand navigation contains links to DocuSign Connect and SOAP API guides.
We hope you enjoy the updates to these new tools and would love to hear your feedback: [email protected]. We’re always looking to make our developer experience easier and more effective, so don’t be shy!