Business API Gateway APIs

The Business API Gateway APIs manage devices, subscribers, and groups. These services provide detailed information about subscriber and group members, and administrators.

The REST service APIs perform the following operations.
  • Query one or more users, subscriptions, and groups.
  • Add and remove group members.
  • Create users and devices, associate the devices with the subscriptions, and purchase product offers for the subscribers.
  • Remove a device from a subscription and then delete it.
  • Search for multiple devices, subscriptions, and groups in a single query.
  • Search for virtual balances associated with a group balance.
  • Simulate device usage for testing purposes.
  • Start and stop rating.
  • Get a list of sub-domains.
  • Create a subscription and associate it with a user.
  • Modify user authentication and passwords.

RS Gateway uses SpringBoot which requires that you add a /data prefix to the @RequestMapping at the class level or individual request methods. If the /data prefix is not added, the request path will be wrong (for example, /rsgateway/v3/ instead of /rsgateway/data/v3/). Add the /data prefix if you are not using the MDC, REST, JSON, or OpenAPI auto-generated code. The prefix is automatically added when using auto-generated code.

For examples of the REST service APIs, see the discussion about service API examples.