Webservice

The realtime interface between the shop and the ERP system is implemented as a set of methods on a webservice endpoint that can be called by the shop.

The connector with the ERP system - that is usually implemented by the ERP party - implements the server endpoints of this webservice. The shop implements the client part.

In order to ensure a correct implementation of the Shoxl webservices we provide a WSDL file with the SOAP format and a swagger.json file containing the Open API format of the REST interface.

Depending on the implementation, the shop uses one of these definitions for the communication with the webservice. The current version of the WSDL document is: ShoxlWebService_v5.wsdl.

31KB

ShoxlWebService_v5.wsdl

The current version of the REST interface is ShoxlRestApiSwagger_v6.json.

The pages below contain a description of the REST methods. For a description of the parameters of these methods see the corresponding fields in the documentation of the SOAP API.

27KB

ShoxlRestApiSwagger_v6.json

Security

In order to assure a secure connection between shop and ERP system the endpoint needs to be accessible with the https protocol.

We recommend that that access to the endpoint is restricted to the server IP of Shoxl Server and to the development IP address of Integrace. Next to the IP restriction on the connection we also support basic authentication in order to secure the connection.