# Postman

Want to try out our API's? Try using Postman Postman is an API platform for building and using APIs.

Note for external users - many of the links in the following section refer to internal applications. Please speak to your project team for support.

# Prerequisites

You'll need to download the software to you Windows or Mac. Find the link here (opens new window). For more information on configurable downloads look here (opens new window)

# Importing our APIs

You can import our APIs to be used in postman. Be sure to import the correct environment of API to postman before you get started. Once imported you can re import when their are any API updates. The default authentication methods will be imported, but more are available and able to be configured. See what authentication methods are supported, and how to configure them in postman (opens new window).

# Steps

  1. Download the required microservice swagger json. From the documentation or using a HTTPS request to /json

JSON

You can also use 'Import From Link'. Here paste the URL which generates the JSON format of the APIs from the Swagger or any other API Document tool.

  1. Click on the 'Import' button in the top left corner of Postman UI.
  2. You will see multiple options to import the API doc. Click on the 'Paste Raw Text'.
  3. Paste the JSON format in the text area and click import.

Import

  1. You will see all your APIs as 'Postman Collection' and can use it from the Postman.

Collection

Last Updated: 21/06/2024, 11:34:44