Postman Collection

Snapdocs offers a Postman collection which demonstrates the basic client use cases of Snapdocs Connect.
The collection and the accompanying configuration are here.

This collection works in conjunction with the Postman "Public Collection" environment to provide users a way to run simple end-to-end (ETE) closing workflows. The collection works by saving request responses into environment variables and using the variables in subsequent requests. For example, upon creating a closing, the new closing UUID will be saved and used to upload documents to that closing in a subsequent request.

Click here to learn more about Postman.

---

Before using this collection, ensure to do the following:

1. Download the collection and environment JSON files from here.
2. Import both JSON files in your Postman workspace.
3. Navigate the left navigation menu to Environment > Public Collection and update the variables in your environment. Some default values have been provided for a basic demo. However, you may need to update some variables based on customer support's recommendations. The most important variables are:
   • AuthBaseUrl — URL for acquiring an authentication token
   • BaseUrl — URL to access Snapdocs Connect
   • ClientId — the preconfigured client ID for authentication
   • ClientSecret — the preconfigured client secret for authentication
   • audience — the API you intend to call using a token generated by this request.
   • company_id — Snapdocs's assigned company ID for your organization
4. Select the Public Collection environment.

After the environment is set up for the Postman collection runner, you can:

• Select the entire collection and click 'Run' to execute all the workflows contained. Or,
• Run individual workflows by either:
  • Select the Auth > Regular Use sub-folder and click Run to obtain an authenticated client.
  • Select any of the individual workflows and click Run. For example, I can select the Closings > ETE Happy Path Wet Closing sub-folder to try out some common API requests leading from creating a wet closing to completing it.