Overview

Use Master Data API to enable the API client to integrate with the CPaaS Master Data service. The main function of the Master Data Service is to manage master data for CPaaS. It can handle master data related to the client, location and tenant.

Features

The CPaaS Master Data API enables the API client run the following operations:

• Register a new address (POST /address).
• Retrieve list of all addresses (GET /address).
• Retrieve a single client for a given id (GET /clients/{id}).
• Register a new client (POST /clients).
• Search clients (POST /clients/search).
• Set parameter for a client (PUT /clients/{id}/parameters/keys/{key}).
• Update client (PUT /clients/update).
• Invoke data replication by tenant id (PUT /datareplication/by-tenantid/{tenantId}).
• Register a new location (POST /locations).
• Search locations (POST /locations/search).
• Set parameter for location (PUT /locations/{id}/parameters/keys/{key}).
• Update location (PUT /locations/update).
• Retrieve list of all tenants (GET /tenants).
• Register a new tenant (POST /tenants).

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

Security

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