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.
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.

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.
      - Simple Start Rating Request
        In its simplest form a rating session start request must define the Service and Amount parameters as shown in business_api_sdk/r_rating_simple_request.html#reference_D58F218A5B8544DDB867C744AF6C6486__table_EA917C323B0745AA93216E2C32414052.
      - MultiServiceList Request
        Include MultiServiceList in RS Gateway-initiated rating requests for multiple services.
      - Start Rating and Refund Request
        The following sections describe sample rating requests and responses for a charge and a refund.
      - Start Rating Response
        business_api_sdk/r_rating_start_response.html#reference_4676CEF17C0149A8BBFD91FB270F892B__section_CE76F841ABF84DFBA13F1F63683BC8CC shows the start rating response for each of the preceding start rating requests.
    - 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.
    - 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

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.

Using the REST service APIs for rating, external clients can request usage rating and charging. The APIs expose Diameter Ro based functionality and allow both event and session-based charging. The client must provide session IDs for stop and update requests. For start requests, the client can supply the session IDs or the MATRIXX Engine can assign them. A session ID is used for the life of the session to request more units, report consumption, and to update or terminate the session. External clients must implement the required Diameter functionality before using the APIs. The rating APIs are stateless.

Note: If the SessionId is not provided in the initial start rating request, the RS Gateway assigns a value to the SessionId in the format:

http-8080-thread[threadID] : 12345678

An MD5 hash value is generated from the SessionId and assigned to the AccountingSessionId and NormalizedSessionId. The SessionId must be provided in the stop rating request.

RS Gateway-initiated rating supports the following:

External or legacy charging systems that must report usage.
Content platforms that do not support the Diameter protocol but they generate usage events that must be rated.
Rating for mobile and login devices (for example, using IMSI or MSISDN for mobile devices and LoginId or AccessId for login devices).
Clients can initiate a usage charge event that is rated by the Charging Server.
Simple and multi-service requests.

Note: The start, stop, and update rating session requests should only be used by clients that do not support the Diameter protocol.