B2B communication protocols
SOAP web services integration
SOAP web services exchange XML messages described by a WSDL contract. Many enterprise applications, carriers, government agencies and financial services still provide SOAP interfaces. ECOM calls and exposes SOAP services and maps their messages to EDI, JSON and your ERP.
- Message format
- XML in a SOAP envelope
- Contract
- WSDL with XML schemas
- Security
- TLS plus WS-Security where required
- Transport
- Usually HTTPS
The gateway calls and exposes SOAP services and maps their XML to your systems.
Overview
What SOAP and web services is
A SOAP message is an XML document with an Envelope, an optional Header for things like security tokens, and a Body holding the request or response. A WSDL file describes the service: its operations, the XML each one accepts and returns, and its address.
Because the contract is precise, SOAP services are well suited to formal integrations such as carrier rating and shipping, government submissions and enterprise application interfaces.
Where businesses use it
Carriers and logistics
Rating, label and tracking services offered as SOAP interfaces.
Enterprise applications
ERP, CRM and middleware services exposed with WSDL.
Government and finance
Submissions and inquiries that require signed XML messages.
How it works
How a SOAP call works
The client builds a SOAP envelope for an operation from the WSDL, adds security headers if required, and posts it over HTTPS. The service returns a response envelope, or a SOAP Fault describing an error.
WS-Security can sign parts of the message, encrypt them and carry tokens such as user name tokens or certificates, in addition to TLS on the connection.
The Header carries security; the Body carries the operation and its data, as defined in the WSDL.
In depth
SOAP in practice
WSDL contracts
Operations and schemas come from the WSDL, so requests and responses are validated.
WS-Security
Signatures, encryption and tokens are applied as the service policy requires.
Faults
SOAP Faults are captured and classified as data errors or temporary failures.
SOAP versions
SOAP 1.1 and 1.2 differ in envelope namespace and content type; both are supported.
Attachments
Binary attachments such as labels or documents are handled with MTOM where services use it.
Exposing services
The gateway can also expose SOAP endpoints for partners to call.
In practice
Example: getting shipping labels from a carrier's SOAP service
Each warehouse shipment needs a label from a carrier's SOAP service.
The SOAP call sits in the middle of a larger shipping workflow.
Connections
How SOAP and web services connects your business
Partners and carriers
SOAP services from carriers, agencies and partners.
Applications
Enterprise systems with WSDL interfaces.
EDI and JSON
SOAP data mapped to EDI documents and JSON APIs.
ERP and WMS
Responses update your systems.
ECOM
How ECOM supports SOAP and web services
ECOM supports SOAP and web services with dedicated implementation, mapping, communication and support teams, and with specialists who know the industries your partners work in.
Implementation team
Plans the SOAP and web services setup with you, configures it on the gateway and runs the tests with your partners and systems.
Mapping team
Builds and maintains the maps, code conversions and validation rules between partner data and your applications.
Communication team
Sets up and monitors partner connections, certificates, keys and credentials, and coordinates changes with each partner.
Support team
Watches the flows, investigates failed or missing documents, and works the issue through with you and your partner.
For SOAP and web services in particular
- SOAP clients and endpoints built from WSDL, with WS-Security policies.
- Mapping between SOAP XML and EDI, JSON or your ERP formats.
- Partner onboarding for SOAP: exchanging connection details, testing in both directions and confirming the go-live date with each partner.
- Monitoring of every connection, with alerts for failed, missing or unacknowledged transfers.
Frequently asked questions
What is a WSDL?
A Web Services Description Language file describes a SOAP service: its operations, the XML messages for each and the service address.
Is SOAP still used?
Yes. Many carriers, government agencies, financial services and enterprise applications still offer SOAP interfaces.
What is the difference between SOAP and REST?
SOAP uses XML envelopes with a formal WSDL contract and optional WS-Security. REST uses HTTP methods on resources, usually with JSON. Both run over HTTPS.
Can ECOM expose a SOAP service for our partners?
Yes. The gateway can expose SOAP endpoints and map incoming requests to your systems.
Talk to an EDI/API Expert
Tell us which partners, systems and SOAP and web services requirements you are working with. An ECOM specialist will review them with you and outline the setup, the maps and the tests.