Skip to content

Provided Web services

Automatic provisioning of Web service definitions

The sedex Client automatically retrieves the Web service definitions from the sedex server and updates them regularly.

The sedex Client caches the Web service definitions locally to ensure that the sedex Web Service Proxy will function even if the sedex server cannot be reached. This cache can be used for a maximum of one week. If the list of Web service definitions cannot be updated for more than a week, the sedex Web Service Proxy stops its service with an error message in the log and in the Web service call responses.

Whether the Web service definitions can be updated and how long they are valid is displayed on the sedex Client’s monitoring page (see Monitoring):

[...]
wsproxy-webservice-definitions-updated-at=2019-12-04T13:15:43
wsproxy-webservice-definitions-expires-at=2019-12-05T13:15:43
wsproxy-webservice-definitions-update-status=OK
wsproxy-webservice-definitions-update-info=Updated successfully
wsproxy-webservice-definitions-valid=true
[...]

List of provided Web services

The list of Web services offered by a sedex Web Service Proxy differs from sedex participant to sedex participant and depends on the rights configured on the sedex server for the particular participant.

The list of Web services currently available for a specific sedex Client can be viewed on its monitoring page (see Monitoring). The following excerpt shows the definition for the Web Service CheckSedex:

[...]
wsproxy-webservice-CheckSedexWebService-address-http=
http://localhost:8080/wsproxy/services/CheckSedexWebService
wsproxy-webservice-CheckSedexWebService-address-https=
https://localhost:8443/wsproxy/services/CheckSedexWebService
wsproxy-webservice-CheckSedexWebService-users=anonymous, authenticated
wsproxy-webservice-CheckSedexWebService-target=
https://sedex-service.admin.ch:443/sedex-clientServices-ws/CheckSedexWebService
[...]

The elements of a Web service definition are:

  • xxx-address-http

    URL of the Web service on the sedex Web Service Proxy using the unsecured HTTP protocol. If HTTP is not available, N/A is shown.

  • xxx-address-https

    URL of the Web service on the sedex Web Service Proxy using the secure HTTPS protocol.

  • xxx-users

    Specifies whether the Web service can be called anonymously, called by any registered user, or exclusively with a specific username and password via sedex Web Service Proxy. Possible values are:

    • anonymous, authenticated

      Username and password are optional.

    • authenticated

      A valid username and password is required.

    • sedexId[username]

      Only users associated with the given sedex ID have access. Existing users with the required sedexId are listed.

      e.g. 1-123-1[example-app-1]

  • xxx-target

    Path of the Web service on the Web service provider. The sedex Web Service Proxy must be able to access this URL.