Testing REST APIs with Postman

docMgt has a full suite of REST APIs that can be used to integrate systems and automate processes. You can access the API reference on any docMgt site using the server’s URL followed by “swagger”. For instance, if your site’s URL is https://acme.docmgt.cloud then the API reference URL would be https://acme.docmgt.cloud/swagger. This documentation shows you all the things you can do with docMgt’s REST interface. However, testing any API can be a daunting task. This is where Postman comes in.

 

Postman

Postman is defined on their site as “… a collaboration platform for API development. Postman’s features simplify each step of building an API and streamline collaboration so you can create better APIs—faster.” From my perspective, the Postman tool allows developers to quickly test API calls and figure out how to work with other systems. It can be quite the life saver for a developer. To get started you need to download the Postman application. You can run it in the browser but you don’t get the full feature set.

If you are new to Postman I would encourage you to run through the tutorials starting here. Once you get comfortable I would encourage you to search for our sample collection by searching Postman for “docMgt.” There are several scenarios laid out including logging in, search records, uploading documents, and more.

Sample Postman Screen

If you have Postman installed then you can also fork our samples here:

 

Related Articles

API – Searching Records

API – Saving Records into docMgt

Easy Development with docMgt REST Helper

Join Our Mailing List

Join our mailing list to receive the latest news and updates from the docMgt team

You have Successfully Subscribed!

Pin It on Pinterest