BMC Helix Mid-Tier - How to test a Third-Party REST API Using Postman - INCLUDES VIDEO
Knowledge Article
BMC Helix Mid-Tier - How to test a Third-Party REST API Using Postman - INCLUDES VIDEO
How to test REST APIs Using Postman Utility before integrating with BMC Helix ITSM
Remedy AR System Server
AR System Mid-Tier WAR Files Version 20.02.03
All Helix ITSM Supported Versions
Remedy AR System Server
AR System Mid-Tier WAR Files Version 20.02.03
All Helix ITSM Supported Versions
How can I conduct testing of a REST API in a graphical environment?
It is always advisable to test a REST service before integrating it with Helix ITS, ensuring that it functions properly. This allows us to focus solely on making it work with Helix ITSM.
Due to its robustness and ease of use, Postman is one of the most commonly used tools for conducting REST API tests.
First you need to install postman and have a JDK or JVM installed, to download postman go to their website
https://www.postman.com/ And pick your OS
On Demo video, I will perform the most common actions to test a REST I will be using a public application application which contains various REST API available for the general public, this is the url https://bookstore.demoqa.com/swagger/
1.- In the first example I will demonstrate how to get the list of available books consuming this REST
This example do not requiere any kind of Authentication
2.- I wil be creating a user, on this application you need to generate your usename and password to execute other REST, this is not a common use case, but it will be great if you create your own user and perform all the tests. 3.- I will assign a book to to the user I have created, using Basic Authentication, passing the credentials that we have created and the ISBN of one of the available books.
4.- I will query my user to confirm the book has been assigned to me. In this example, we need to pass our credential using Basic Authentication
Notes These examples only use Basic Authentication or None Authentication, there are many types of authentication like
Basic Authentication
Barer Token Authentication
JWT Token Authentication
oAuth2 Token Authentication
Some error response codes has been generated intentionally to demonstrate what you should expect as a succesfull response, and how to read the error codes, you can see more about HTTP error response codes here:
This KA and Demo video has only the intention to show you how to test your REST services before to integrate them with your HELIX ITSM, is not monitored or supported by BMC
If you need to implemente SSL/HTTPS in order to consume the REST you are testing, please refer to the postman documentation: