Home
MATRIXX Business API SDK
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.
REST Services (RS) Gateway
RS Gateway provides an easy integration point for external REST clients and Java applications to make API calls to MATRIXX Engine.
Understanding the REST Interface
This section includes helpful information about the MATRIXX REST interface. For more information about REST and the SubMan REST APIs, see MATRIXX Subscriber Management API.
REST Helper URLs
The REST interface provides several REST meta-services that can be used to query the RS Gateway and find out information about other services and documents.

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.
  - REST Services (RS) Gateway
    RS Gateway provides an easy integration point for external REST clients and Java applications to make API calls to MATRIXX Engine.
    - User Authentication and Password Management
      Use the /service/user service APIs to set, verify, and modify a user password.
    - RS Gateway-Initiated Rating
      RS Gateway-initiated rating allows clients that do not support the Diameter protocol to use the MATRIXX charging, rating, and pricing functionality.
    - RS Gateway Error Codes
      Project extension developers can define error codes for each extension.
    - Understanding the REST Interface
      This section includes helpful information about the MATRIXX REST interface. For more information about REST and the SubMan REST APIs, see MATRIXX Subscriber Management API.
      - REST Helper URLs
        The REST interface provides several REST meta-services that can be used to query the RS Gateway and find out information about other services and documents.
      - REST Call Schema Definitions
        business_api_sdk/r_schema_defs.html#reference_CE9C07F323704AE792D8EB5292184C6D__table_8AC01128D1E144A7A43982EAD3D3FCFE describes the standard MATRIXX REST call schema.
    - Making Multiple Requests in One API Call
      You can perform multiple engine requests (MtxRequestMulti) using a POST call to the RS Gateway. For example, one request can create a subscriber, create a device, and associate the device with that subscriber.
  - MDC Gateway
    The MDC Gateway conducts the internal exchange of data between MATRIXX servers and external exchange of subscriber management data with other MATRIXX gateways and web apps.
  - Business API Gateway APIs
    The Business API Gateway APIs manage devices, subscribers, and groups. These services provide detailed information about subscriber and group members, and administrators.
- Creating Extensions
  You create extensions using a Maven archetype and then add those extensions to the RS Gateway as JAR files.
- 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

REST Helper URLs

The REST interface provides several REST meta-services that can be used to query the RS Gateway and find out information about other services and documents.

XML REST Helper URLs describes the REST helper URLs.

Table 1. XML REST Helper URLs
URL	Description
GET http://`host:port`/rsgateway/data/v3	Returns the complete list of REST services.
GET http://`host:port`/rsgateway/data/v3/templates	Returns a list of all `MtxRequest` and `MtxResponse` message templates.
GET http://`host:port`/rsgateway/data/v3/templates/{name}	Returns a TEMPLATE for the message named `name`. This message can be any MDC defined in the system. The response is a template message of the appropriate type.
GET http://`host:port`/rsgateway/data/v3/messages	Returns a list of ALL MDC messages names.
GET http://`host:port`/rsgateway/data/v3/update	Gets new MDC definitions from a running engine.
GET http://`host:port`/rsgateway/data/v3/subclasses/{Name}	Return a list of all MDCs derived from {Name}. For example, if B is derived from A and C is derived from B: A->B->C, then calling this method with A will produce a response containing B and C. Calling the method with B will return a list containing only C.

Table 2. JSON REST Helper URLs
URL	Description
GET http://`host:port`/rsgateway/data/json	Returns the complete list of REST services.
GET http://`host:port`/rsgateway/data/json/templates	Returns a list of all `MtxRequest` and `MtxResponse` message templates.
GET http://`host:port`/rsgateway/data/json/templates/{Name}	Returns a TEMPLATE for the message named `name`. This message can be any MDC defined in the system. The response is a template message of the appropriate type.
GET http://`host:port`/rsgateway/data/json/messages	Returns a list of ALL MDC messages names.
GET http://`host:port`/rsgateway/data/json/update	Gets new MDC definitions from a running engine.
GET http://`host:port`/rsgateway/data/json/subclasses/{Name}	Return a list of all MDCs derived from {Name}. For example, if B is derived from A and C is derived from B: A->B->C, then calling this method with "A" will produce a response containing "B" and "C". Calling the method with "B" will return a list containing only "C".