BoldSignDocumentation
BoldSign Mobile Icon

Getting started with Postman

Mon, 14 Nov, 2022

Postman 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.

Getting started

  • You can either use Postman on the web or Postman desktop app.
  • Sign up and sign in to the Postman.
  • Click the below link to view the BoldSign APIs in Postman or you can search for BoldSign API using the search option in Postman.
    https://www.postman.com/boldsign
  • You will be taken to the BoldSign API’s overview page. Click the Collections tab and select BoldSign API.
  • The BoldSign API’s are categorized as follows, and they can be found on the right side of the page.
    • Branding
    • Document
    • Plan
    • Sender Identity
    • Teams
    • Template
    • Users
  • Expand the category to view all the APIs under that category.
  • Click on a particular API to check the details of that API like query params, body, etc.

BoldSign APIs in postman

Fork the collection

To send an API request, first you need to fork and create a copy of the original collection under your workspace. Follow the steps below to fork the collection.

  • Click the Fork option on the BoldSign API page. The Fork collection dialog box will appear.
  • Enter values in the Fork label and Workspace fields, then click the Fork Collection button.

Fork collection dialog box

  • Now, you will be navigated to the My Workspace page, where you can find the collection in the Collections section.

Authorization

Then you should authorize to try out the API’s. You can do this by following the below steps.

  • Click on the API which you want to try out from the section on the left side. The API’s details and settings will be opened on the right.
  • Click the Authorization tab and you can see all the supported types in the dropdown.
  • Now select the API Key in the Type dropdown. You can find the Key, Value, and Add to fields on the right side.
  • Enter X-API-KEY in the Key field, the valid API key in the Value field, and select Header in the Add to field.

Authorization

Try it out

Next you can send API requests by specifying the required parameters. For example, let us see the steps to list the documents in My Documents section.

Document list API

  • Fill in all the required parameters in the Params section, then click the Send button.
  • If you want to download the result in JSON format, click the dropdown in the Send button and select Send and Download option.
  • Now, all the document’s details in My Documents section will be displayed.
  • While executing this API, if the entered API key is valid, the success code 200 will be displayed.

Success code

  • If the entered API key is invalid, then the unauthorized code 401 will be displayed.

Error code

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

  • Click on the Document Properties API and add https://api.boldsign.com in apiBaseUrl.
  • Select the Params section, enter documentID in the Key field, then enter the id of the document in the value field and click the Send button.

Document Properties API

  • Now, all the details of that particular document will be displayed.
  • 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