The following information is an overview of the SubMan APIs and architecture.
MATRIXX Subscriber Management API provides information about the MATRIXX Engine APIs, including functions, syntax, and result codes, and the MATRIXX Engine REST and Java API implementations.
The Subscriber Management (SubMan) API defines a set of programming interfaces to the MATRIXX in-memory databases.
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. The SubMan AP has two language bindings: Java and REST.
The diagrams in this section show the API message workflow for primary and secondary resources.
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.
MATRIXX Engine maintains transactional subscriber data that enables you to address in real time 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).
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.
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.
Each response includes a basic result code indicating success or failure and textual information about any failure. A result code of 0 (zero) is a success and a result code of nonzero is a failure.
The SubMan API calls include domain routing information.
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.
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.
The following sections introduce how the various in-memory objects are managed.
The SubMan API reference includes SubMan API and MDC descriptions.
RS Gateway supports the REST API bindings for accessing subscriber data in MATRIXX Engine. RS Gateway consists of an rsgateway application and a set of REST APIs.
This part describes how to use the REST API bindings to interface with MATRIXX Engine.
This part provides an overview of how to use the Java™ API binding for the SubMan v3 API as an interface to the MATRIXX Engine.
