Home
Subscriber Management (SubMan) API
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.

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.
  - SubMan Data Objects
    An external application or system can use the SubMan APIs to perform operations on primary, secondary, and embedded objects. Primary objects can be called directly by the API and include subscribers, groups, devices, and users. Wallets are secondary objects because they belong to a primary object. Operations on wallets must reference a primary object. Embedded objects include product offers, balances, thresholds, and billing cycles.
  - SubMan API Architecture and Deployment
    The SubMan API is the externally-visible element of the Subscriber Management interface. The interface uses a standard client-server model, where a MATRIXX gateway is the server and any external application that needs to access and manipulate data related to subscribers and groups is the client. There are two language bindings available for the SubMan API: Java and REST.
  - SubMan API Functions
    The SubMan API functions provide a standardized way to define, send, and receive MATRIXX data. They support generic arguments so applications can use the same programming primitives to communicate with MATRIXX Engine.
  - SubMan API Syntax
    The generic syntax of each API request and response operation includes a description, the base MDC container used by the operation, and the data elements used by the operation.
  - SubMan API Result Codes
    Each response includes a basic result code indicating success or failure and textual information on any failure. A result code of zero is a success and a result code of non-zero is a failure. Result codes are mapped from internal MATRIXX error codes.
  - SubMan API Sematics Workflow
    The diagrams in this section show the API message workflow for primary and secondary resources.
  - SubMan API Migration-Specific APIs
    The SubMan APIs can initialize balances for on-demand balance intervals.
  - SubMan API Domain Routing
    The SubMan API calls include domain routing information.
  - SubMan API Execute Mode
    The SubMan API execute mode determines if data changes are saved to the internal database when a SubMan API call is made and if credit limits are ignored.
  - MDC Serialization
    The data container package for MATRIXX Java components provides three different formats for serialization: XML, JSON, and OpenAPI JSON. These serialization formats depend on MATRIXX MDC definition files. MDC serialization describes data containers, structs, simple types, arrays and lists, and special fields.
  - Log in to RS Gateway Administrative UI
    The RS Gateway administrative UI provides documentation for all MATRIXX Web app classes and methods, XML messages, JSON templates, and filter definitions.
- 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.
- 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

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.

MATRIXX Engine is a message-based, transaction processing system. All MATRIXX messages are defined by MATRIXX Data Container (MDC) definitions. The SubMan API operates on top of this foundation by encapsulating an API call into a special message that is processed by the engine. The API functions and objects are built using language-independent MDC object definitions. When an external application sends a message, a MATRIXX gateway converts the request into MDC format. Once the request is serviced, the response is returned to the client application by the gateway.

External applications or systems, such as a CRM system, can use the SubMan API to perform the following operations:

Create and manage subscriptions, groups, and users.
Create and manage devices.
Purchase and cancel product offers.
Modify existing objects (subscribers, groups, devices, product offers, users) using the Attr field.
Manage balances, credit limits, and notification thresholds.
Retrieve pricing plan information, billing cycles, balance classes, thresholds, and service types.
Initialize balances for on-demand balance intervals.

Language bindings for the API calls are available wherever an MDC implementation exists. Currently this includes Python and Java. In addition, REST services are automatically generated from the MDC function definitions. REST calls support XML, JSON, and OpenAPI.

Extended REST service APIs which are implemented only in the RS Gateway are documented in Business API SDK. These APIs include REST services that manage subscribers, groups, and devices, including rehoming operations. Also, you can start and stop rating sessions. Unlike the APIs described in Subscriber Management (SubMan) API, these APIs do not have a Python or Java equivalent. Also, MATRIXX Web App Administration documents all My MATRIXX REST bindings.