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.

Business API Gateway Architecture

Figure 1 shows the Business API Gateway in the MATRIXX architecture.
Figure 1. Business API Gateway
Business API Gateway with communication between external clients, RS Gateway, Gateway Proxy, and network

The following sections describe each component in the Business API Gateway. For more information about the MATRIXX architecture, see MATRIXX Architecture.

REST APIs and RS Gateway

Application tiers communicate with RS Gateway using REST services (XML and JSON). Use the APIs to do the following:
  • Query event from the Event database, any in-process aggregated events, and theEvent Repository. Multiple data sources are queried to present a seamless, real-time view of all available events. Queries can filter events by subscriber, time ranges, and event type to provide flexibility when presenting product offer and balance usage information.
  • Query in-progress aggregated events.
  • Query balances.
  • Query delivered notifications for subscriptions and groups.
  • Create devices and associate them with a subscription.
  • Add subscriptions and groups to groups.
  • Remove subscriptions and groups from groups.
  • Associate users with specific roles with groups.
  • Use search terms to query specific information about subscribers and groups, including members of a group, subscribers who are administrators, all administrators of a group, and sub-groups of a group.
  • Query pricing cache details from the lazy-loaded pricing cache.
  • Query delivery event confirmations.

For more information, see the discussion about Business API Gateway APIs in MATRIXX Business API SDK. For more information about the SubMan APIs, see MATRIXX Subscriber Management API.

Note: When you deploy the rsgateway.jar file, you can access the documentation for the Java bindings and SubMan API calls from the RS Gateway administration UI.

You can extend the APIs with new services or enhance and replace existing services. For more information about customizing the APIs, see MATRIXX Business API SDK.

RS Gateway uses the Spring Security Framework to authenticate clients. Roles assigned to the client define authorization for specific URLs. For more information about security, see MATRIXX Security.

Gateway Proxy

Gateway Proxy provides the services that enable external applications to send data securely to MATRIXX Engine through MDC Gateway. It communicates with RS Gateway and acts as an intermediary for clients making requests to MATRIXX Engine and for responses from MATRIXX Engine to external applications. In installations that include a Traffic Routing Agent (TRA), MDC Gateway communicates with the TRA to route SubMan calls.

Business API SDK

The Business API Software Development Kit (SDK) provides the APIs, libraries, and other resources needed to write client applications that integrate with MATRIXX.

Application Tier

The application tier includes MATRIXX Backoffice Customer Tool and the Notification Server. Use MATRIXX Backoffice Customer Tool to view and manage subscriber and group account information, including purchased offers, services, and balance amounts. The Notification Server delivers notification messages to configured delivery channels and returns the notification message text and delivery ID to the Charging Server. Spring Security handles user authentication and authorization. For more information about gateway security, see the discussion about configuring RS Gateway security in MATRIXX Security.