Tip: Using POSTMAN to test IFS Webservices

  • 3 November 2019
  • 6 replies
  • 2501 views

Userlevel 7
Badge +15
  • Superhero (Partner)
  • 256 replies

Postman is popular as a REST client but it works really well with SOAP requests as well and can be used to test IFS Web Services/BizApi requests.

Hope following guide will help if anyone is interest in using Postman as a SOAP client for IFS integrations.

Postman can be freely download from here.

Following steps show how to make SOAP requests using Postman:

1. Create a new Request

Give the SOAP endpoint as the request URL

  • Apps 10: https://<APP_SERVER_URL>:<PORT>/int/soapgateway
  • Previous IFS versions: http(s)://<APP_SERVER_URL>:<PORT>/fndext/soapgateway

Set the request method to POST.

 

2.Set Auth Header

Go to the Auth Tab,

Select Type as Basic Auth

Type IFS username and password to be used for the integration

 

3.Set SOAPAction Header

Next step to add the SOAPActin header, which is required by IFS SOAP Gateway to identify incoming message as a SOAP request

  • Key = SOAPAction
  • Value =

Synchronous:

urn:soap_access_provider:<BizAPI_Name>

or

urn:soap_access_provider:<Handler_Name>:<Operation_Name>

 

Asynchronous- suffix the header with /post

urn:soap_access_provider:<BizAPI_Name>/post

or

urn:soap_access_provider:<Handler_Name>:<Operation_Name>/post

 

4.Adding body

Go to the Body tab, select Type as raw - XML

Put the SOAP message.

* You can generate sample request by using following format in a web browser or can view from Interface browser

https://<APP_SERVER_URL>:<PORT>/int/soapgateway?handler=<Handler_Name>&op=<Operation_Name>&type=xml_request

 

That’s basically what you need to create a SOAP request using POSTMAN. Have fun and post your comments!

 

More detail about IFS SOAP can be found in F1Doc

 

Cheers!

Damith


6 replies

Badge +1

Hi Damith,

I’m trying to test calling a custom API with a SOAP message. 

As I’m therefore not using a BizAPi or Handler, how would I go about testing this?

This is a new area to me so any advice would be brilliant!!

 

Userlevel 7
Badge +15

Hi Damith,

I’m trying to test calling a custom API with a SOAP message. 

As I’m therefore not using a BizAPi or Handler, how would I go about testing this?

This is a new area to me so any advice would be brilliant!!

 

 

Hi @RyanIbbitson ,

 

Can you please explain what you meant by custom API?

Is it a PL SQL method which you intended to call via a routing address (valid for App10) or any other business flow?

 

/Damith

Badge +2

Hello Damith,

i just heard from someone of the IFS stuff, that for BIZAPI’s like ReceiveEInvoiceService:ReceiveEInvoice, which are setup with a transformator between the inbound message and the BIZAPI, the sample request  https://<APP_SERVER_URL>:<PORT>/int/soapgateway?handler=<Handler_Name>&op=<Operation_Name>&type=xml_request  is just showing the message after the transformator. Can you confirm this ?

 

And according to this person there is no way to know how the message should like before the transformation, except of digging through the source of the transformator and search for the mapping of all C00 / N00 and similar fields

Userlevel 7
Badge +15

Hello Damith,

i just heard from someone of the IFS stuff, that for BIZAPI’s like ReceiveEInvoiceService:ReceiveEInvoice, which are setup with a transformator between the inbound message and the BIZAPI, the sample request  https://<APP_SERVER_URL>:<PORT>/int/soapgateway?handler=<Handler_Name>&op=<Operation_Name>&type=xml_request  is just showing the message after the transformator. Can you confirm this ?

 

And according to this person there is no way to know how the message should like before the transformation, except of digging through the source of the transformator and search for the mapping of all C00 / N00 and similar fields

 

Hi @Michael45678 ,

 

yes, ReceiveEinvoice has a generic format for receiving invoices and it need basic data setup in IFS and as well as knowledge of each field definition to set it up correctly. 

There’s no real ‘transformer’ between the incoming message fields and IFS fields and it’s done in the PLSQL logic. If you are curious about the code, receiving invoice process starts from INVOICE_TRANSFER_API.RECEIVE_INVOICE:wink:

 

Regards,

Damith

Userlevel 4
Badge +10

Thank you :relaxed:

Badge +1

Can you provide the same type information for the REST API functionality? I’ve been trying to setup Postman and so far I’ve not been able to gain a token even though I have the client Id and secret.

Thanks

Reply