This part describes how to use the REST API bindings to interface with MATRIXX Engine.
The group management APIs include the messaging required to operate on the group object. The APIs include the messaging and data elements required to create, modify, associate, and query objects directly related to the group.
These calls manage users associated with groups.
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 following information is an overview of the SubMan APIs and architecture.
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.
The following APIs are deprecated in this release of MATRIXX and support for these APIs will be removed in a future release.
The balance management APIs include the messaging required to operate on a balance, meter, or wallet object. The primitives include the messaging and data elements required to create, modify, associate, and query objects directly related to a balance or meter, including their thresholds.
The catalog APIs return information about pricing catalogs for specified devices, groups, and subscriptions. They return catalog items that the specified object is eligible to purchase.
Use the following MDCs to import data for users, subscriptions, groups, and devices and to import catalog item purchase information for a subscription.
The device management APIs include the methods and functions required to operate on the device primary object. They include the data elements required to create, modify, and query devices, to add and remove a device from a subscription, and to delete a device from the Subscriber database.
This section describes the APIs for querying catalog items based on eligibility. The APIs return catalog items that the specified object is eligible to purchase.
The event APIs include the messaging and elements to return events and notifications in the Event Repository and the event database for subscriptions, groups, and users.
External payment APIs query external payment requests and get a list of external payment request records in a wallet.
This call adds one or more subscriptions, groups, or both, to a group. Any groups specified cannot already belong to another group. When a subscription is added to a group, an MtxGroupAddMembershipEvent EDR is generated.
Check a catalog item for cycles that can be aligned to on purchase or modification. One and only one of OfferRequest and OfferResourceId must be provided.
OfferRequest
OfferResourceId
These services implement the request of debt payment to a contract and the request of payment to a group's finance contract using the resource ID of the contract.
This call makes a request to create a new group in the subscriber database.
This call deletes a group. All balance write-offs or other fiscal impacts should be completed before this operation.
The recurring charge API returns an estimate of the recurring charges and grants for all the upcoming balance cycles or the billing cycle for a given group.
This method is used to add a user to a group.
This method is used to modify a user to a group roles.
This method is used to remove a user from a group.
This service returns the users associated with a group. querySize=xx: An optional request parameter querySize (default is 10) can be specified that determines the number of records returned per call. queryCursor=yy: If the query results do not fit in a single response, a QueryCursor is included in the response. If the cursor is NULL or 0 you are at the end. You can retrieve the subsequent pages of a response by calling this URL again but specifying a queryCursor parameter on the url.
These calls make a request to modify information in an existing group. Only those fields with values supplied are modified in the Group object. If an extended object Attr field is supplied, it must be of the same type used to create the group.
Attr
Subscriber, group, and device event queries query the in-memory event database. You can include optional parameters in the URL to filter the results. For information about querying the event database and the Event Repository, see the discussion about the event REST APIs.
This call makes a request to query a group. The group can be identified by the Group OID or External ID.
The group payment APIs add, query, and delete Pay Now payment information for groups.
Use the recharge APIs to request a recharge to a group actual currency balance, query the recurring recharge associated with a specified subscription and manage recharge schedules associated with a subscription.
This call makes a request to remove existing members from a group. All subscriptions or sub-groups specified must be direct children of the parent group.
The multi-tenant APIs get tenant information for individual tenants and all tenants.
My MATRIXX supports GET, PUT, and POST REST bindings. The { } notation around text represents a URL parameter.
{ }
Use these APIs to query a list of status life cycles for an offer. You can query specific offer status life cycle using the profile ID.
The integration layer REST APIs manage payment authorization tokens for the payment gateway from the integration layer. These tokens are necessary for the client to communicate directly with the payment gateway to create a payment method in the payment gateway.
The policy APIs allow you to query the Sy policy counters for a specific device.
The pricing management APIs return information about all aspects of pricing, including catalog items, balance templates, product offers, billing cycles, life cycles, notifications and so forth. You can also get status information for the currently-loaded pricing.
The product offer management APIs include the messaging to activate, purchase, cancel, and modify catalog items. You can identify a product offer by its object ID or the external ID assigned during pricing plan creation.
Use the purchase package APIs to manage catalog items in a purchase package, including adding and removing catalog items for subscriptions, groups, and devices, and suspending, resuming, and canceling purchase packages.
The MtxRequestSubscriberEstimateRecurringCharge SubMan API estimates balance impacts from recurring processing of currently failing recurring cycles and upcoming recurring cycles (active purchased items cycles, balance cycles and billing cycles).
The rehoming APIs move a subscription, group, device, or user from one customer sub-domain to a different sub-domain. For a description of the rehoming process, see the discussion about rehoming subscribers, groups, devices, and users in the object management overview.
The extended REST service APIs are implemented only in the RS Gateway. These APIs include REST services that manage subscribers, groups, and devices, including rehoming operations. In addition, you can start and stop rating sessions using the service APIs. Unlike the APIs described in MATRIXX Subscriber Management API, these APIs do not have a Python or Java equivalent. For information about the service API default filters, see the discussion about REST filters.
Use these APIs to query status life cycle information for devices, groups, subscriptions, and users from the engine.
The status modify APIs schedule status changes and delete scheduled status changes. They also suspend and resume purchased items (product offer or bundle) if the current offer status class permits the action.
The Subscriber REST APIs described here are deprecated and will be removed in a future release.
The subscription management APIs include the messaging required to operate on the subscriber object, which is a primary object for MATRIXX interactions. The API bindings include the messaging and data elements required to create, modify, and query objects directly related to the subscription. A subscription must have a wallet secondary object, which is created for the subscription at subscription creation time.
The system REST APIs query the MATRIXX Engine to check if recurring recharge is enabled, return domain and sub-domain information, return tenant IDs, and create Pay Now client tokens.
The tax APIs manage information in the US Tax database.
Use the User REST APIs to add, update, query, and delete users. You can also get and modify user authentication data, associate users with groups and subscriptions, and modify or remove those associations.
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.
