Home
MATRIXX Business API SDK
Creating Extensions
You create extensions using a Maven archetype and then add those extensions to the RS Gateway as JAR files.
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.
Creating the Offer Purchase Extension Class and Methods
In this section, you define the extension class using stubs to test the extension and update the REST service to use the Spring object manager.
Test the Extension
In this task, you build the purchase project and test the new REST service using a REST client. Testing requires a Gateway Proxy pointing to a running MATRIXX Engine.

Welcome
MATRIXX Release Notes
MATRIXX Architecture
MATRIXX Installation and Upgrade
MATRIXX Configuration
MATRIXX Security
MATRIXX Integration
MATRIXX Diameter Integration
MATRIXX Call Control Framework Integration
MATRIXX TM Forum Integration
MATRIXX 5G Integration
MATRIXX 5G Event Streaming
MATRIXX Event Streaming
MATRIXX Administration
MATRIXX Web App Administration
MATRIXX Monitoring and Logging
MATRIXX Policy
MATRIXX Kafka CDR Consumer
MATRIXX Pricing and Rating
MATRIXX Pay Now
MATRIXX Subscriber Management
MATRIXX Subscriber Management API
MATRIXX Business API SDK
- About MATRIXX Business API SDK
  MATRIXX 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 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.
- Creating Extensions
  You create 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 MATRIXX Data Containers (MDCs) from MATRIXX Engine and 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 pod.
  - Creating Multi-Request REST Services
    This section describes how to create new services that are an orderly set of atomic SubMan multi-requests.
  - 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.
    - Getting Started
      Before you begin, follow the instructions in the discussion about creating extensions to install and initialize the SDK and create a project.
    - Creating the Offer Purchase Custom MDCs
      In this section, you will create the custom MATRIXX Data Containers (MDCs) to hold the custom data.
    - Creating the Offer Purchase REST Service
      This section describes how to create the REST service that enables you to purchase a custom product offer.
    - Creating the Offer Purchase Extension Class and Methods
      In this section, you define the extension class using stubs to test the extension and update the REST service to use the Spring object manager.
      - Define the Extension Class
        In this task, you define the extension class and method stubs to test the custom REST call.
      - Test the Extension
        In this task, you build the purchase project and test the new REST service using a REST client. Testing requires a Gateway Proxy pointing to a running MATRIXX Engine.
      - Update the Class
        In this task, you will change the DemoServices class to extend from JsonStubs.
      - Add Helper Functions
        In this task, you will add two helper functions to query a subscriber and purchase an offer.
      - Change the Implementation Method
        In this task, you change the implementation method to query the subscriber before an offer purchase, purchase the offer, query the subscriber after the purchase, and add logging functions to help trace through the code.
      - Add Required Imports
        In this task, you must add the imports required in this sample extension.
    - Build and Deploy the Extension
      When the custom extension is complete, add it to the classpath and restart the RS Gateway.
  - 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).
- Upgrading the Business API SDK
  When you upgrade the MATRIXX 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
MATRIXX Third-Party Licenses
Glossary

Test the Extension

In this task, you build the purchase project and test the new REST service using a REST client. Testing requires a Gateway Proxy pointing to a running MATRIXX Engine.

About this task

For information about installing and managing MATRIXX, see MATRIXX Installation and Upgrade.

For more information about the MATRIXX environment variables, see the discussion about container directories and environment variables in MATRIXX Installation and Upgrade.

Procedure

Go to to the /mtxsdk/projects/target/purchase directory.
Copy the extensions.jar file to the /opt/mtx/ext/common directory.
Edit the /opt/mtx/conf/extension-containers.yaml file.

Note: If this file does not exist, you must create it.

Add the MDC definition files to extension-containers.yaml.

For example:

extension-core: /extension-containers.yaml
Extension-rest: /extension-rest-mdc.xml

Copy the libraries or dependencies to /opt/mtx/ext/common the directory.
Build the project.
At the command prompt, type:
```
mvn clean install
```
Copy the rsgwextension.jar file to the /opt/mtx/ext/rsgateway directory.
Enter the following command to restart RS Gateway:
sudo systemctl restart mtx_rsgateway
Check the RS Gateway log file (/var/log/mtx/rsgateway.log) to confirm that the extensions loaded correctly.
Configure the Gateway Proxy on the local pod to communicate with a running engine.
See the discussion about configuring the Gateway Proxy in MATRIXX Installation and Upgrade.

Using your REST client, send the following request.

URL:

POST http://localhost:8080/rsgateway/data/json/demo/subscriber/1-2-3-4/offer

Request Body:

{"Type": "phone", "Amount": 52.99, "Color":rose-gold}

Results

If the purchase project is working correctly, you should see the following response.

{
"$": "DemoResultSubscriberPurchase",
"Result": 0,
"ResultText": "Ok -> hello from DemoServices",
"_resultCode": 0,
"_resultText": "Ok -> hello from DemoServices",
"_resultType": "Create"
}

What to do next

Update the REST service.