Home
MATRIXX Business API SDK
Creating Extensions
You create JAR file extensions using a Maven archetype and then add those extensions to the RS Gateway as JAR files.

Welcome
Release Notes
Architecture Overview
MATRIXX Cloud Native Installation and Configuration
MATRIXX Cloud Native Integration
Implementing MATRIXX in a Cloud
Installation and Configuration
MATRIXX Digital Commerce Upgrade
MATRIXX Security
MATRIXX Engine Administration
MATRIXX Web App Administration
MATRIXX Engine Integration
Call Control Framework Integration
MATRIXX Diameter Integration
MATRIXX 5G Integration
MATRIXX Monitoring and Logging
Pricing and Rating
MATRIXX Pay Now
MATRIXX Policy
MATRIXX Event Streaming
Subscriber Management
Subscriber Management (SubMan) API
MATRIXX Business API SDK
- About Business API SDK
  Business API SDK provides the APIs, libraries, and other files needed to create a customized version of the RS Gateway.
- 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.
- Business API Gateway
  The Business API Gateway is a development framework that includes the Business API SDK, Rest Services Gateway (RS Gateway), Gateway Proxy, and application tier. It allows custom mobile applications, Web clients, and other custom implementations to integrate with MATRIXX Digital Commerce.
- Creating Extensions
  You create JAR file extensions using a Maven archetype and then add those extensions to the RS Gateway as JAR files.
  - Installing and Initializing the SDK
    Before beginning RS Gateway extension development, you must install the MATRIXX dependencies in the local Maven repository. Use the provided installation script or do it manually.
  - Creating a Project
    After you install the SDK dependencies, create a project using the MATRIXX Extension Maven archetype.
  - Defining the Extension
    Creating an extension involves multiple steps, including defining custom MDCs from MATRIXX Engine and the RS Gateway in the Extensions module MDC files, defining the REST APIs, and defining the routing rules.
  - Testing Extensions
    During extension development, test your code at different stages.
  - Deploying the Extension
    Each extension module described in the discussion about creating an extension has a JAR file which you deploy to the RS Gateway server.
  - Creating Custom REST Services
    This section describes how to create custom REST services.
  - Example Offer Purchase Extension Project
    This section describes a project that creates a custom RS Gateway call that enhances offer purchasing. The project defines a custom offer purchase URL with a custom payload which returns balance impacts.
  - Example REST Tax Service
    This section describes a project that implements a tax service.
- Creating Custom Filters
  You can create a custom filter by creating a named filter or a filter class. A named filter is useful for simple filters while a filter class should be used for complex filters (for example, when the returned results must be modified).
- Referral Rewards Extension
  The Referral Rewards RS Gateway extension is a set of APIs that return a unique referral code for a subscriber that you can use subsequently when creating a new subscriber.
- Product Catalog Extension
  The Product Catalog RS Gateway extension is a set of APIs that allow users to control the visibility of catalog items to the subscriber (eligibility), and to control which catalog items can be purchased together (compatibility).
- Upgrading the Business API SDK
  When you upgrade the MATRIXX Digital Commerce software, you must upgrade the Business API SDK as it is possible that files have changed or have been deprecated. Use the manage_integration_project.py script to remove the current release from your project directory structure and upgrade to the latest release. You should do this even if your files are not checked into Subversion.
- Appendixes
My MATRIXX Help
MATRIXX Backoffice Customer Tool Help
Third-Party Licenses
Glossary

Creating Extensions

You create JAR file extensions using a Maven archetype and then add those extensions to the RS Gateway as JAR files.

The archetype is a single library that defines a skeleton Java project, including all required artifacts. After completing your extension, you copy one or more JAR files to the RS Gateway server and restart the RS Gateway.

Note: You should be familiar with Maven functionality and concepts. Some tasks described here assume you have a basic knowledge of Maven. In addition, these tasks require that Maven is installed on the machine where you develop your RS Gateway extensions. For more information about Maven, see the Maven website.

Use the MATRIXX Maven archetype template to build your own custom RS Gateway extensions. The template has a base POM file (an XML descriptor file) for the Maven project and example extension code. Maven creates a local repository for all dependencies.

Most integrated development environments (IDEs) support project creation from an archetype. See the documentation for your IDE for details.