CPaaS Tenant API

Overview

The CPaaS Tenant API supports managing a region-specific data for individual tenants. It is used to manage hierarchical key-values associated with nodes of the Business Unit and Client tree structure.

  • Based on the externalId of a Business Unit, the API can return a flattened list of key-values from all parent nodes.
  • Based on the clientId of a Client (POS) and the externalId of a Location, the API can return a flattened list of key-values from all business units and a collection of key-value pairs for all client parameters.

Business Unit Parameters are set once for the whole location and apply to all clients inside location.
Client Parameters are set separately for each and every client inside the location.
Health Check is to check the API health status including backend services status.

The following diagram depicts an example of an organizational structure with Business Units and Clients:
Tenant_BU_Structure.PNG

NOTE: The CPaaS API only supports certain regions. For configuration details please refer to the CPaaS Documentation Suite.

Features

The CPaaS Tenant API provides endpoints that enable you to define values for a particular Busineess Unit (BU) and Client parameters. You can manage the parameters in the following way:

  • View details of all the BU Parameters using the GET /businessunits/parameters endpoint. You can also filter the business unit parameters list by providing a key.
  • View details of all the BU Parameters for a specific locations under a tenant ID using the GET /businessunits/{externalId}/parameters endpoint.
  • Remove a BU Parameter for a specific location using the DELETE /businessunits/{externalId}/parameters/{key} endpoint.
  • Register a specific BU Parameter using the POST /businessunits/parameter endpoint.
  • View details of all Client Parameters using the GET /clients/parameters endpoint.
  • View details of all BU Parameters and Client Parameters for a specific Client using the GET /locations/{externalId}/clients/{clientId}/parameters endpoint.
  • Remove a Client Parameter for a specific location using the DELETE /locations/{externalId}/clients/{clientId}/parameters/{key} endpoint.
  • Register a specific Client Parameter using the POST /api/clients/parameters

Security

The CPaaS Tenant API supports OAuth 2.0 for authentication purposes.
The supported protocol for the CPaaS Tenant API is HTTPS.