Board and SOAP APIs

Ken Walsh · 2023-08-01T08:50:40+00:00

There was an error rendering this rich post.

One of our APIs that customer requires a connection to does not have a REST API, but only a SOAP interface.

I know that I can connect to this using PowerShell, but does any Board expert have any suggestions or recommendations as to the best way to get Board to interact with a SOAP API?

Find more posts tagged with

Accepted answers

Andrea Duò

Hi Ken,

SOAP is a legacy API protocol and it has being almost completely replaced by REST in the past few years. Board does not have the capability to directly consume SOAP services which normally return xml outputs. We will have to find a "bespoke" approach through an intermediate step that invokes the service and "converts" it into a format that Board can ingest. Scripting tools like PowerShell and Python could be a solution.

Andrea

All comments

Andrea Duò

Hi Ken,

Andrea

Ken Walsh

Thanks for your response Andrea, as discussed I will speak to our partner who is supporting this customer and we can work together to find a solution.

Mark Cosham

Thanks Andrea, Ken posted this one for me because I was having issues logging into Community after the SSO changes.

AHPRA only have a SOAP interface. https://www.ahpra.gov.au/Registration/Employer-Services/External-data-exchange-services/Practitioner-information-exchange.aspx

I have already built an initial connection using PowerShell and will use SQL Server to call this via a SQL Agent Job triggered from a change to a table as this client is hosted by Board and therefore can't call the script directly.
In this case, I'm aiming to have the PowerShell script write directly to SQL tables for Board to read.

From your response earlier, it looks like this is an appropriate approach.

I also considered using SSIS, but I am not familiar with it and it appears that PowerShell will be more flexible.

I'm also looking to use PowerShell for different a REST API where the data is returned as structured JSON.

Thanks,
Mark

Andrea Duò

Hi Mark,

yes, the approach you described is a good solution to integrate Board with SOAP services.

As for your last sentence, when you need to consume REST services from Board, you can do it directly through the REST API Call procedure action.

Andrea