BoldSignDocumentation
BoldSign Mobile Icon

Using the API Explorer

Thu, 10 Nov, 2022

API explorer is helpful to check out all the available API’s and to try out them easily. The API details like parameters, request body, and responses will be displayed. You can try out the API’s by passing the required parameters and can receive the responses. To try the API’s, you must authorize by entering the valid Bearer or API key.

Getting started

  • Explore the BoldSign API’s in this link - https://api.boldsign.com/swagger/index.html
  • The API’s are categorized and displayed as follows.
    • Branding
    • Document
    • Plan
    • Teams
    • Template
    • User
  • When you click on any API it will expand and the details like parameters, request body, and responses will be displayed.

Selecting a definition

  • You can switch between the stable and beta version API’s by using the dropdown at the top right corner.

Selecting a definition

Authorization

  • As stated above, you should authorize to try out the API’s. You can do this by clicking the Authorize button.

Authorize button

  • A popup will be displayed. You can enter the valid Bearer or API key in the value field and click the Authorize button.

Authorization dialog box

Try it out

You can find the Try it out option in all the APIs. Click that option to try the API. For example, let us see how to list the documents in My Documents section.

  • Click on the /v1/document/list API in the Document section and click Try it out button.

Try it out

  • Fill the necessary parameters and it is mandatory to fill the parameters which are marked as required. Then click the Execute button.
  • Now, all the document’s details in My Documents section will be displayed.

User documents

  • While executing this API, if the entered API key is valid, the success code 200 will be displayed.
  • If the API key is invalid, then the unauthorized code 401 will be displayed.

Now let us see another example on how to get the summary of a document.

  • Click on the /v1/document/properties API in the Document section and click Try it out button.
  • Enter the id of the document in the documentId field and click the Execute button.

 Document id

  • Now, all the details of that particular document will be displayed.

 User details

  • While executing this API, if the entered API key is valid, the success code 200 will be displayed.
  • If the API key is invalid, then the unauthorized code 401 will be displayed.
  • If the entered document id is invalid, then the forbidden code 403 will be displayed.
Copied to clipboard