Demo clients for ePages 6 web services

Project links

• Company website: http://www.epages.com
• Source code: https://github.com/ePages-de/soapclient/
• Issue tracker: https://github.com/ePages-de/soapclient/issues
• Release repository: https://bintray.com/epages/maven/epages-soapclient/

Requirements

• epages 6.11.0+

Running tests with Gradle

1. run ./gradlew check (Linux) or gradlew.bat check (Windows) in project folder.
2. If epages6 is not installed locally, use the system property "wsHostName" to an epages6 installation (-DwsHostName=somehost)

Development in Eclipse

1. Install "Gradle IDE" Eclipse plugin from Spring.
2. Run "File / Import... / Gradle Project"
3. Select location of soapclient source, and run "Build model"
4. Select soapclient and all subprojects and click Finish
5. If epages6 is not installed locally, use the system property "wsHostName" in launch configuration to point to an epages6 installation (-DwsHostName=somehost)

Configuration

The tests can be run with either default configuration, or by specifying system properties, changed to alternative URLs, or using alternative login credentials.

• With no configuration we will default to DemoShop with user admin with password admin
• Custom username and password can be set via command-line using system properties -DwsUser=/Path/to/User and -DwsPassword=somePassword. Mind that passing a different credentials is not supported by the C# client yet.
• The feature "Program Interface for Web Services" must be enabled in the shop. Alternatively you can register an application key/password and using these credentials can be achieved by specifying the properties -DwsAppName= for the application name, and -DwsAppPassword= for the password. (java and perl only)
• Web service endpoint defaults to http://$wsHostName/epages/Store.soap and can be overwritten via system property -DwsUrl=http://someUrl/epages/Store.soap. If epages6 is installed locally, there is a discovery of the correct URL from SystemDomainName defined in $EPAGES_CONFIG/epages.conf

Note

For backward compatibility this package also contains older versions of some web service interfaces. New applications should use the latest version of each web service, i.e. the one with the highest version number.

Project Structure

• $clientLanguage/shop : Shop Webservices
• $clientLanguage/provider : Provider Webservices

Avaiable clients

Perl client

Requirements

• Perl 5.10+
• SOAP::Lite
• Test::More

Running test cases

Either run via gradle using gradle check in the subproject, or call perl runTests.pl directly.

C# client

Requirements

• Micsosoft Visual C# 2008 Express Edition / Xamarin Studio 4.2
• the NUnit-Test-Framework

Java client

• JDK 1.7.0 Standard Edition See http://java.oracle.com/j2se/

• Apache Axis Web Service Framework (version 1.4) See http://axis.apache.org/axis/

Using java soapclients as SDK

1. Include jCenter to your maven repository resolution (http://jcenter.bintray.com) For gradle this could look like:

   repositories { maven { url 'http://jcenter.bintray.com' } }

2. Add a dependency to epages-soapclients.

   dependencies { // dependency for shop webservices compile 'de.epages:soapclient-shop:1.4.17' // dependency for provider webservices compile 'de.epages:soapclient-provider:1.4.17' }

Regenerating stub classes

1. run ../../gradlew generate (Linux) or ../../gradlew.cmd generate (Windows) in java/$x subproject folder.
2. If epages6 is not installed locally, use the gradle property "wsdlBaseUrl" to point to a WSDL directory or an epages6 installation (-PwsdlBaseUrl=http://somehost/WebRoot/WSDL/)
3. You usually only want to regenerate stubs for a specific webservice, so pass the gradle property "onlyThisService" (-PonlyThisService=ProductTypeService2)

License

Copyright 2013-2015 ePages GmbH

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.