Luc Morissette: New page for Postman

2023-08-07T18:52:29Z

New page for Postman

New page

{{DISPLAYTITLE:Northbound interface: Postman Tool Integration}}

Postman is an API(application programming interface) development tool provided by third party that helps to test APIs. Almost any functionality that could be needed by any developer is encapsulated in this tool.
It has the ability to make various types of HTTP requests(GET, PUT, POST, DELETE).
* Postman tool is another example of how to use TelcoBridges RESTful Northbound Interface.
* The application tool can be run from any computer having access to the management web interface.

== Download application ==
*[https://www.getpostman.com/ Get postman]

== Usage ==

* When sending HTTP requests to Telcobridges management interface for manipulating with Telcobridges configurations' resources, the HTTP request must be following the [[Northbound interface:RESTful#HTTP_headers|HTTP headers]] as listed above.
* Out of these headers, besides Host information and Authorization, Content-Type is important, and must be specified as "application/json" in order to return right result
* Other headers are either already complying or optional, and becoming less important when using default headers values as provided by Postman

== GET ==
Include the authorization with "Basic Auth",

[[Image:GET_HTTP_request_from_Postman_Authorization.png|1000px]]

Get the configuration collection list and display the JSON returned in the body of the HTTP response.

[[Image:GET_HTTP_request_from_Postman.png|1000px]]

== PUT ==
Modify attributes of an element. Below example renames the route element named "Test_Codec" to "Test_Codec1".
* With the authorization and header set like GET
* Specify the route name that will have name changed, in this case, "Test_Codec"
* Go to "Body" tab, click "raw", and select "JSON"
* Copy the new name parameter as {"name":"Test_Codec1"}
* Press Send, and will receive 200OK

[[Image:PUT_HTTP_request_from_Postman.png|1200px]]

== POST ==
Create a new element. Below example add a new route named "xtel_to_SBC_1".
* With the authorization and header set like GET
* Specify the route name to be added, in this case, "xtel_to_SBC_1"
* Go to "Body" tab, click "raw", and select "JSON"
* Copy the new name parameter as {"name":"xtel_to_SBC_1","nap" : "Test_Codec","remapped_nap" : "NAP_SS7_7443"}
* Press Send, and will receive 200OK

[[Image:POST_HTTP_request_from_Postman.png|1200px]]

== DELETE ==
Delete an element. Below example delete the route named "xtel_to_SBC_1".

[[Image:DELETE_HTTP_request_from_Postman.png|1200px]]

== PUT (for activate configuration) ==
Activate a configuration. Below example is to put (thus activate configuration) for the configuration named "Config_test_CDR".
* system name, in this case, is "support_lab_tmg3200"

[[Image:PUT Activate HTTP request from Postman.png|1200px]]

== References ==
*[https://www.geeksforgeeks.org/introduction-postman-api-development/ Introduction to Postman for API Development]
*[https://www.guru99.com/postman-tutorial.html/ Postman tutorial]
*[https://www.getpostman.com/ Get postman]

Postman tool integration - Revision history

Luc Morissette: New page for Postman