Business API SDK Overview

The Business API SDK is a flexible framework that includes a set of tools to manage, customize and extend the REST Services Gateway (RS Gateway) for customer-specific business needs. Using the SDK, you can extend existing projects or create entirely new projects to add, replace, or modify services that leverage existing functionality.

The Business API SDK is part of the Business API Gateway and leverages the Spring Security features included with RS Gateway and the Gateway Proxy.

Build JAR file extensions to RS Gateway and add the extension project JAR file to the classpath to deploy it.

The advantages of using the Business API SDK to create a custom RS Gateway include:
  • The same service provider for all MATRIXX services contributes new REST calls.
  • Information for pricing components such as product offers and bundles for which RS Gateway provides rich caching services is efficiently accessed.
  • RS Gateway determines when pricing objects have changed and you do not need to recreate this functionality.
  • You can share and reuse code implemented in the Business API SDK in future projects. Reuse is possible with:
    • Derivation — Projects can depend upon other Business API SDK projects.
    • Composition — You can design a custom RS Gateway by combining multiple Business API SDK projects.
  • Multiple entry points share the same code base; both the JSON and XML versions of a specific REST call use the same implementation class.
  • Type-safe get and set methods for the request and response attributes are code generated. Support for atomic values (int, long, double, and so forth), custom structures, and array and list support of both the atomic values and the custom structures is provided.
  • After building the extension project as a JAR file, you add it to the classpath and restart RS Gateway to enable the extension.

Third-Party Software Requirements

Table 1 describes the Business API SDK third-party software requirements.
Table 1. Third-Party Software Requirements
Software Description
Maven The Business API SDK uses Maven for building extension projects.
Important: The Business API SDK requires Maven version 3.6.3 or later.
Java Development Kit (JDK) A suite of tools for Java Developers. The JDK is required by My MATRIXX, RS Gateway, Business API Gateway, Gateway Proxy, Payment Service, Event Stream Server, and Notification Server. You must install the JDK on any server where you install these components.

For supported versions of required third-party software, see the discussion about third-party software requirements in Installation and Configuration.

Examples

This guide includes several example RS Gateway extensions. The examples describe the procedures necessary to create a custom RS Gateway. You should have a good understanding of Java and REST concepts. The examples include the following:
  • Offer Purchase Extension
  • Tax Service
  • Custom Filter
Important: You must install the matrixxsw-bizapps-misc.rpm file to have access to the extension examples. After installing the RPM, the examples are available in the /opt/mtx/bin directory.