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.
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.
Add REST API Definitions
You must add the REST definition files to the src/main/resources/rest directory of the RS Gateway Extension module to group the REST APIs together. This directory can contain multiple files, each of which can contain multiple REST definitions.
GET API Example
This example shows how to create a GET service to query a subscriber.

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.
    - Add Custom MDCs
      Custom MATRIXX Data Containers (MDCs) that you create during MATRIXX Engine configuration are defined in the /opt/mtx/conf/mdc_config_custom.xml file. You must add these custom MDC definitions and any custom REST API MDCs to the extension project.
    - Add REST API Definitions
      You must add the REST definition files to the src/main/resources/rest directory of the RS Gateway Extension module to group the REST APIs together. This directory can contain multiple files, each of which can contain multiple REST definitions.
      - GET API Example
        This example shows how to create a GET service to query a subscriber.
      - POST API Example
        The example shown here demonstrates how to create a POST service to request a payment settlement.
    - Add the Extension Class and Methods
      You must add an Extension class containing a method which implements each REST service.
    - Build the Extension
      The extension build process creates one or more JAR files that you deploy to the RS Gateway pod.
  - 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.
  - 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

GET API Example

This example shows how to create a GET service to query a subscriber.

<MtxRestServices xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
    xmlns='http://www.matrixxsw.com/XML_Schema/rest_service'
    xsi:schemaLocation='http://www.matrixxsw.com/XML_Schema/rest_service
    http://www.matrixxsw.com/XML_Schema/rest_service.xsd rest_service.xsd ../rest_service.xsd'>
        <info>
            <class>extension</class>
            <filename>src/main/resources/rest/extension.xml</filename>
            <date>2019-06-19T15:25:27</date>
        </info>
        <path_array>
            <path url="/demo/subscriber/{SubscriberSearchTerm}">
                <service id="GET">
                    <name>demo_query_subscriber </name>
                    <description>Query the subscriber </description>
                    <request>DemoRequestSubscriberQuery </request>
                    <response>DemoResponseSubscriberQuery </response>
                    <parameters>
                        <UrlParameterArray>
                            <url_param>
                                <description>Default is the object id of the subscriber (line).
                                Qualifiers of ObjectId+, ExternalId+, AccessNumber+ can be specified.
                                </description>
                                <name>SubscriberSearchTerm</name>
                                <type>RestQueryTerm</type>
                            </url_param>
                        </UrlParameterArray>
                    </parameters>
                    <code_generation>
                       <mapping>readData</mapping>
                       <mapping>attachVersion 1</mapping>
                       <patch>route = setRoute(route, SubscriberSearchTerm)</patch>
                       <callout_statement>
                           com.matrixx.rsgateway.configuration.DemoServices svc = (com.matrixx.rsgateway.configuration.DemoServices )m_appContext.getBean("DemoServices");
                           svc.demoQuerySubscriber(SubscriberSearchTerm, reqMsg, rspMsg)
                       </callout_statement>
                    </code_generation>
                </service>
            </path>
        </path_array>