Testing Using Postman

Postman is a popular tool for working with APIs. We have published a collection for testing and documentation using Postman.

Postman provides extensive features for performing integration testing with out API. It allows for repeatable, reliable tests that can be automated and used in a variety of environments and includes useful tools for persisting data. See the Postman Learning Centre.

Download the latest version of Postman from https://www.getpostman.com/.

You will then need to fork our collection from Postman. Click the “Fork” button in the top-right and follow Postman’s instructions.

The collection will then be available from the sidebar under "Collections":

The collection comes with various example requests, that have been set up with collection variables, the main one being server which by default is pointing to localhost and will need to be changed if running on-premise.

This can be done easily by going to the Variables tab of the collection and changing the current value of server: