Back to all labs


SOAP (Simple Object Access Protocol) is an XML-based messaging protocol for transferring information.

What is a SOAP API?

What is a SOAP API?

SOAP is a messaging protocol for transferring information via the internet. SOAP uses XML for exchanging messages.

A SOAP message is an XML document containing the following parts:

EnvelopeThe start and the end of the messageYes
HeaderThe optional attributes of the message used in processing the messageNo
BodyThe data comprising the message being sentYes
FaultProvides information about errors that occur while processing the messageNo
Loading component...

Example of a SOAP API

The following component shows an example of what a SOAP API request and response looks like. Click on the Send request button in the component below to understand the syntax of a SOAP API request and response.

Loading component...