Configuring the CloudBlue Commerce Public API

The purpose of the CloudBlue Commerce Public API is to provide external billing systems with a way to perform accounting and billing operations together with CloudBlue Commerce.

The API represents a set of methods implemented over XML-RPC. All methods conform to XML-RPC specifications so that the external system can use any third-party software implementing this protocol.

You can make CloudBlue Commerce accept OpenAPI connections only from allowed hosts and networks. However, a management node can call CloudBlue Commerce using Open API by default. BMBridge SC also registers the host where Billing lives in the list of allowed hosts during its installation.

To configure various security aspects of CloudBlue Commerce Public API using the PCP, go to System > Settings > Public API in the Integration group. On the Summary tab, you can view the following information:

  • XML-RPC URL – in the Access Point field.
  • Current state of the service – in the Accept Connections field. Here two values are possible: Only from allowed networks and From everywhere.
  • Configuration of OpenAPI security parameters.