Official web page for Magja
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
CNAME
LICENSE
README.md
_config.yml
configuration.md
examples.md

README.md

Welcome to Magja

Magento is a popular and emerging open-source e-commerce platform written in PHP with a market share of around 30%.

Magja provides a Java Connector for Magento's Core API that allows easy integration with the shop installation and allows for exchange data offered by the API. In doing so, Magja bridges the gap between the PHP system and Java ecosystem by offering a Java-Style client for integration in any kind of applications.

Core Features

Magja currently provides the following features:

  • Basic support for Magento 1.x SOAP API V1
  • Rich API support
  • Open for custom extensions of the API (without code generation)

Magja allows for exchange of the following data with your Magento installation:

  • Product data
  • Product media
  • Product link
  • Product categories
  • Product attributes
  • Country data
  • Region data
  • Customer data
  • Order data
  • Invoice data
  • Cart data

Getting started

Installation and configuration

Magja artifacts are available in the Maven central repository. Please add the dependency to your project:

<dependency>
  <groupId>net.magja</groupId>
  <artifactId>magja</artifactId>
  <version>1.1.0</version>
</dependency>

to get started. In order to connect to your Magento Shop installation, you need to put magento-api.properties on your classpath. You can copy an example properties from samples folder. Essentially, the properties are self-explanatory:

# SOAP XML/RPC user
magento-api-username=<replace with user>

# SOAP XML/RPC api key
magento-api-password=<replace with api key>

# URL of the Magento installation
# If your shop is installed not using a prefix e.g. /magento
# please add the prefix to the path:
# http://<yourmagento-host>/magento/index.php/api/soap/
magento-api-url=http://<yourmagento-host>/index.php/api/soap/

# the ID of the default attribute set
default-attribute-set-id=4

# the ID of the default root category
default-root-category-id=2

For further configuration please refer the configuration guide.

Basic usage

Magja is offering a set of services which can be used to access the Magento API. A service can be obtained from the RemoteServiceFactory instance. The sample usage is demonstrated below:

Logger log = LoggerFactory.getLogger("logger");
RemoteServiceFactory remoteServiceFactory = new RemoteServiceFactory(MagentoSoapClient.getInstance());
ProductRemoteService productService = remoteServiceFactory.getProductRemoteService();

Product product = new Product();
product.setSku("0001-QWER-12090");
product.setName("Milk");

try {
  productService.add(product);

  List<Product> allProducts = productService.listAll();
  for (Product shopProduct : allProducts) {
    log.info("{}", shopProduct);;
  }

} catch (ServiceException e) {
  log.error("Error manipulating products", e);
} catch (NoSuchAlgorithmException e) {
  log.error("Error manipulating products", e);
}

More examples can be found in the examples section