Official Postman Guide: https://learning.postman.com/docs/introduction/overview/
Postman is an online tool that helps to test and communicate with RESTful APIs. In order to make integration with the FHIR REST APIs easier, we have published a postman collection that can be used to authenticate, query, fetch and search the data on the Terminology Server. You must have appropriate access to be able to use some of the functions such as modifying data. Review the postman collection and use it as a template to get your own script of software application integrated with our APIs. We have a GitHub repository with the Postman collection stored as a file which you can import into your own workspace. See details below. Instructions provided here are meant to help users get started. Please always rely on the official documentation provided by Postman for up-to-date instructions and list of available features.
GitHub Repository
You can access the Postman collection from our GitHub repository. You can import the collection into your own Postman workspace and make any changes or modifications as you see fit.
[GitHub Repository] https://github.com/terminologystandardsservice/public
Get Authorization Token in Postman
Before you can make any queries to the FHIR API, you must get an authorization token. You can either use your personal username and/or password for Terminology Server or a System account.
Personal Account
- Login to Postman.
- Navigate to the forked collection.
- Click on Terminology Standards Service Collection.
- Click on Authorization tab.
- If you are using Postman for Desktop, please add the following URL as the Callback URL. https://oauth.pstmn.io/v1/browser-callback
- Click on Get new Access Token at the very bottom of the page.
- It will take you to the login page.
- Enter your username and password to login.
- You will get a popup saying you "Authentication Complete".
- Click Proceed.
- Click on Use Token
- Now you can navigate to any of the examples and press the Send button to get a response from the Terminology Server.
System Account
- Process for using a system account is very similar to that of the personal account.
- Login to Postman.
- Navigate to the Forked Terminology Standards Service Collection.
- Click on the Authorization tab.
- Select Client Credentials under Grant Type.
- Enter the Client ID and Client Secret in the appropriate fields.
- Click on Get new Access Token.
Please refer to the official Postman Documentation for any support or further detailed instructions.