Providing a new Web Service

Contact sedex Support with your request

In order to make your Web service accessible via the sedex platform, a legal basis is required. Normally this means that only Web services which are located in the domain of e-government are suitable.

Please contact the sedex team to check if your Web service can be offered via sedex. The contact details can be found at www.sedex.ch.

How the WSDL Schema is delivered to the users of sedex Web Service Proxy

The sedex Web Service Proxy itself does not contain a WSDL schema for a Web service. That means it can only deliver a WSDL schema if the original Web service provides one under its endpoint URL followed by the expression ?wsdl. This is a best practice and is followed by most Web services.

If the real Web service supports the download of the WSDL schema, it can also be downloaded through the sedex Web Service Proxy by adding the expression ?wsdl to the URL.

If the original Web service does not offer a WSDL schema via its URL, it can not be downloaded via sedex Web Service Proxy. In this case, the WSDL schema must be obtained in another way according to the instructions of the respective Web service provider.

How to provide the WSDL Schema

The following technical details must be fulfilled in order to offer the WSDL scheme on your Web service:

• A WSDL scheme can consist of one or more files:
  • A main file, the WSDL file
  • Optionally one or more XSD files can be referenced
• The Web Service Proxy performs a so-called “URL rewriting” operation before the WSDL or XSD files are delivered to the business application. This allows that all URLs are adjusted to be fetched through sedex Web Service Proxy and thus the referenced files can be obtained by the business application.
• All referenced XSD files have to be provided by the Web service itself. Referenced external files on other servers/URLs (e.g. the eCH repository) can not be properly rewritten and thus are not supported.
• A URL for downloading the WSDL file must contain the expression ?wsdl.
• A URL for downloading referenced XSD files must contain the expression ?xsd or .xsd.
• The URL to download the WSDL schema files must start exactly the same as the endpoint URL of the Web service.

• Example:

  • Endpoint URL of the Web service:

    https://ws.myservice.ch:443/myservice/ws/service

  • Supported WSDL URLs:

    https://ws.myservice.ch:443/myservice/ws/service?wsdl https://ws.myservice.ch:443/myservice/ws/service?xsd=1 https://ws.myservice.ch:443/myservice/ws/service/myservice.xsd https://ws.myservice.ch:443/myservice/ws/service/wsdl/myservice.xsd

  • Unsupported WSDL URLs

    • Problem: Different path:

      https://ws.myservice.ch:443/myservice/ws/wsdl/myservice.xsd

    • Problem: Different host:

      https://wsdl.myservice.ch:443/myservice/ws/service/myservice.xsd

How to verify accessing the WSDL Schema through Web Service Proxy

In order to verify the accessibility of the WSDL schema for a certain Web service via sedex Web Service Proxy, first of all the Web service has to be provisioned by sedex. See the monitoring page of the sedex Client for a list of the available Web services. For details about the monitoring page see Monitoring.

One way to verify the accessibility to the WSDL files is to try to import the WSDL schema using the free Web service utility SoapUI available at www.soapui.org/downloads/soapui.

Follow these steps in SoapUI for performing a very simple verification:

1. File > New SOAP Project

2. In the field “Initial WSDL” of the dialog box specify the URL of the WSDL schema at your sedex Web Service Proxy:

   https://[yourHost]:[yourPort]/services/yourservice?wsdl

   Select [yourHost] and [yourPort] according to your sedex Web Service Proxy installation.

3. Otherwise, use the default settings of the dialog and click “OK”.

If the project can be created successfully, the WSDL could be accessed via your WS Proxy and everything is configured correctly.