Home
MATRIXX Business API SDK
About Business API SDK
Business API SDK provides the APIs, libraries, and other files needed to create a customized version of the RS Gateway.

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
MATRIXX Business API SDK
- About Business API SDK
  Business API SDK provides the APIs, libraries, and other files needed to create a customized version of the RS Gateway.
  - Updated Information
    This Business API SDK publication is updated with each release of the product or when necessary.
- Business API SDK Overview
  The Business API SDK is a flexible framework that includes a set of tools to manage, customize and extend the 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 Digital Commerce.
- Creating Extensions
  You create JAR file 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).
- Referral Rewards Extension
  The Referral Rewards RS Gateway extension is a set of APIs that return a unique referral code for a subscriber that you can use subsequently when creating a new subscriber.
- Product Catalog Extension
  The Product Catalog RS Gateway extension is a set of APIs that allow users to control the visibility of catalog items to the subscriber (eligibility), and to control which catalog items can be purchased together (compatibility).
- Upgrading the Business API SDK
  When you upgrade the MATRIXX Digital Commerce 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
Third-Party Licenses
Glossary

About Business API SDK

Business API SDK provides the APIs, libraries, and other files needed to create a customized version of the RS Gateway.

Intended Audience

This information is intended for anyone that wants to customize the services provided by the RS Gateway. Custom services can be extensions, replacements, or entirely new services. Integrators should be already familiar with the principles and practices of the Java and Representational State Transfer (REST) (XML and JSON) style of software architecture in addition to having a good understanding of MDC (MATRIXX data container). For information about the (SubMan) APIs, see Subscriber Management (SubMan) API. For information about MATRIXX Data Containers, see Installation and Configuration.

Conventions

This guide uses the following conventions.


Bold	Identifies items whose names are predefined by the system, such as user interface controls.
`Italics`	Identifies variables that are parameters whose actual names or values are to be supplied by the user.
Monospace	Identifies file names and directories, data value examples, code examples, blocks of code, references to code snippets inline, system messages, and commands supplied by the user.

Documentation Feedback

MATRIXX Software strives to provide concise, complete, and accurate product documentation and welcomes all feedback. If you have any comments, corrections, or suggestions for improvement, please send them to [email protected].

Support

MATRIXX Software works with you to plan, configure, implement and integrate a MATRIXX Engine installation into your data center. Technical support services include:

Discovery and sizing services.
Installation and configuration services.
Data migration and update services for pricing and subscribers.

For more information about MATRIXX services, please contact us.