Home
Subscriber Management (SubMan) API
Using the MATRIXX REST API
This section explains how to use the REST API bindings to interface with MATRIXX Engine.

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
- About Subscriber Management (SubMan) API
  Subscriber Management (SubMan) API provides information about the MATRIXX Engine APIs, including functions, syntax, and result codes, and the MATRIXX Engine REST and Java API implementations.
- SubMan API Overview
  The Subscriber Management (SubMan) API defines a set of programming interfaces to the MATRIXX in-memory database. In addition, the Event Repository REST APIs return events and notifications in the Event Repository and in the Activity database (in-progress aggregated events) and event database for subscriptions and groups. The SubMan API can be used to manage the various in-memory objects in a defined manner, allowing an exchange of subscriber and group data between external applications and MATRIXX Engine.
- Subscriber Data
  MATRIXX Engine maintains transactional subscriber data that enables you to act in real-time to subscriber needs and service usage. The MATRIXX subscriber model is flexible and supports any type of subscriber base, such as retail, wholesale, and mobile virtual network operator (MVNO).
- Object Management Overview
  The following sections introduce how the various in-memory objects are managed.
- Connecting RS Gateway to the Event Repository
  The Event Repository REST APIs return events and notifications in the Event Repository and in the Activity database (in-progress aggregated events) and Event database for subscribers and groups. The RS Gateway must be configured to connect to the Event Repository.
- Using the MATRIXX REST API
  This section explains how to use the REST API bindings to interface with MATRIXX Engine.
  - RS Gateway REST Authentication
    When the RS Gateway is configured not to accept anonymous requests in the /opt/mtx/conf/rsgateway_anonymous_user.yaml file, clients must send a login request with a username and password.
  - REST Error Handling
    Each response to a request to RS Gateway produces an HTTP result code. This result code indicates the success or failure of the request being received for processing. Additionally, each successfully processed request generates a response and all responses contain a Result (numeric code) field and ResultText (string) field that describe whether the engine was able to perform the request.
  - REST Syntax
    One of the values of using REST is that its syntax is simple, which makes REST requests easy to read. This section lists the REST syntax rules that you must keep in mind when creating a REST request.
  - REST Operations and HTTP Mappings
    All operations across all resources (primary and secondary) are on single instances of a resource, for example, a single device. To perform multiple operations in one transaction, use the MtxRequestMulti function.
  - REST URL and Method Format
    MATRIXX uses the standard REST URL and method formats.
  - 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 Filters
    XML and JSON REST calls include default filters which you can disable. You can include filters which customize the information returned in the response.
  - RS Gateway Initiated Rating
    RS Gateway initiated rating allows clients that do not support the Diameter protocol to use the MATRIXX Digital Commerce charging, rating, and pricing functionality.
  - Update the MDC Definitions for RS Gateway
    After extending an MDC definition with custom fields or upgrading the MATRIXX Engine schema, follow this procedure to update the MDC definitions for RS Gateway. This enables applications that communicate with the engine to operate on the new fields and revert to previous service provider versions, if necessary.
  - RS Gateway Swagger Documentation
    You can request the complete RS Gateway JSON Swagger documentation. The Swagger OpenAPI data structure uses version 3.0.0.
  - converter.jar
    The converter.jar utility converts REST call output files from compact MDC to compact XML files, compact XML to compact MDC files, or compact XML or MDC files to JSON files.
- REST API Reference
  This chapter describes the SubMan REST APIs.
- SubMan API Reference
  The SubMan API reference includes SubMan API and MDC descriptions.
- Using the MATRIXX Java API
  This section provides an overview of how to use the Java™ API binding for the SubMan v3 API as an interface to the MATRIXX Engine.
MATRIXX Business API SDK
My MATRIXX Help
MATRIXX Backoffice Customer Tool Help
Third-Party Licenses
Glossary

Using the MATRIXX REST API

This section explains how to use the REST API bindings to interface with MATRIXX Engine.

The RS Gateway supports the REST API bindings for accessing subscriber data in MATRIXX Engine. The RS Gateway is located on the MATRIXX Proxy Server, and consists of an rsgateway application and a set of REST APIs.

The RS Gateway uses Web standards, such as HTTP, OpenAPI, XML, and JSON, to exchange information. This makes it easy to integrate MATRIXX Engine with a SOA-based enterprise architecture.

When relevant, the REST API overview topics (such as the discussion about group REST APIs) include related reference links to the related Java APIs which provide additional details on the API fields.

Documentation — View documentation for all classes and methods.
XML Messages — View all XML messages and their descriptions.
JSON Templates — View all JSON templates and their contents.
Filters — View all known filters.
REST Call Swagger — View a list of all REST calls with their URL parameters and REST parameters.
Web App Status — View system properties, application properties, and JVM arguments.
Note: You must have the role RSG_DEBUG to access Web App Status.