Restful API testing with postman along with Aurena

  • 8 June 2021
  • 1 reply
  • 382 views

Userlevel 4
Badge +3

 

This is how I'm using the POSTMAN tool to check restful methods (POST, GET, PATCH, DELETE). (I'll proceed with this testing using the 'Inventory Part Maint Info' page in Aurena)

 

The first step should be finding the SOAP gateway. To find that there are two ways.

  1. In Aurena Search for the API Explorer-> search for required projection. (In this case, I'm searching for the 'MaintInventoryPartHandling' projection).
  2. Open the debug console→ Server invoke → Click API Explorer→  click Open in API Explorer. (This would be the easiest way to open it).

 

Afterward, check the ' Include in Compatibility Application Type'  is 'Yes' or 'No'. If it is No, change it to Yes by RMB on the line and click the 'Include in Compatibility Application Type' option.

 

Then, you can open the API Doc by RMB on the line → Documentation →  API Doc [Compatibility Application Type (Int)].  Provide the credentials which are used to log into Aurena.

 

By opening Debug console in Aurena, if you refresh the page you can get the API Request. From that, you can find the handler.

 

From the API Doc search for the handler. Then you will get all the API methods that can be used in Aurena. 

 

POST method is used to create a new resource.

  1. From API Doc select the post method and copy the request.
  2. Open the POSTMAN tool and click 'Add Request and paste the copied request and set the request as POST. 
  3. Copy the payload by hitting the 'Copy' link.
  4. Paste it into the body section and provide the necessary data.
  5. Change the Authentication type into Basic Auth and provide credentials.
  6. Click send button. Bottom of the tool you will get the response.

The following two images will show all the above steps(Numbers are included).

 

GET method is used to retrieve values. 

  1. All the records.
    1. Copy the request from the API doc, add it to the POSTMAN, and change the request type into GET. 
  2. By Key
    1. Copy the request from the API doc, add it to the POSTMAN, and change the request type into GET. Need to pass Primary keys 

 

PATCH method is used to update values.

  1. Copy the request from the API doc, add it to the POSTMAN, and change the request type into PATCH and set the Key values.
  2. In the Body Section, add fields you need to update. Make sure to add it as a JSON value. 

 

DELETE Method is used to remove values.

  1. Copy the request from the API doc, add it to the POSTMAN, and change the request type into DELETE and set the Key values.
  2. In the Header section, add a new parameter call 'If-Match'(If does not exist) and set values as '*' 

 

This is an example, how to use POSTMAN along with the Aurena for restful API service testing.

I think this document may help you to do Restful API testing.
I would like to know other ways of doing Restful testing. If you have ideas, I would please to welcome them. 

Banuka.

 


1 reply

Userlevel 5
Badge +7

@Banuka Perera very useful information. 

But when you get API documentation after setting Compatibility Application Type=YES ,\

the documentation can not be loaded for cloud managed customers. As an example if we run , (App10 UPD12)

https://<host name>.ifs.cloud:48080/main/ifsapplications/apidocs/?openApiUrl=https://<host name>.ifs.cloud:48080/int/ifsapplications/projection/v1/SubContractContactsHandling.svc/$openapi?V3

inside a browser in a local PC instead of its own VM or citrix environment is gives following error

 

Something went wrong...

Error downloading https://<host name>.ifs.cloud:48080/int/ifsapplications/projection/v1/SubContractContactsHandling.svc/$openapi?V3 HTTP ERROR 403

Stack trace

Error: Error downloading https://<host name>.ifs.cloud:48080/int/ifsapplications/projection/v1/SubContractContactsHandling.svc/$openapi?V3 

HTTP ERROR 403

    at https://<host name>.ifs.cloud:48080/main/ifsapplications/apidocs/js/redoc.standalone.js:63:6628

    at https://<host name>.ifs.cloud:48080/main/ifsapplications/apidocs/js/redoc.standalone.js:122:36080

Error: HTTP ERROR 403

    at https://<host name>.ifs.cloud:48080/main/ifsapplications/apidocs/js/redoc.standalone.js:63:6628

    at https://<host name>.ifs.cloud:48080/main/ifsapplications/apidocs/js/redoc.standalone.js:122:35658
 

Could you please mention what causes this and how to troubleshoot. All the other URLs in Aurena can access from the browser in local PC even when Compatibility Application Type is set to No. 

Reply