Yeastar Central Management - Reseller - Version 1.1

Overview

The Yeastar Central Management - Reseller - Version 1.1 collector retrieves reseller-level subscription allocation data from the Yeastar Central Management (YCM) platform using the YCM Open API.

This collector provides visibility into each reseller’s subscription capacity — including extension counts, concurrent call capacity, call recording capacity, ultimate plan allocations, and PBX instance counts — enabling service providers to validate reseller subscriptions and allocate costs within Varibill.

The collector retrieves unrated allocation data, meaning no monetary values are supplied by the source system. Pricing and billing calculations are applied within Varibill based on configured contracts and pricing rules.

This is a point-in-time collector, meaning each execution retrieves the current state of reseller subscription allocations at the time of collection.

For general instructions on creating and running Source Collectors, see: Configuring a New Cloud Source Collector

Collector Summary

About Yeastar Central Management

Yeastar Central Management (YCM) is a cloud-hosted platform used by service providers and resellers to deploy, manage, and monitor Yeastar Cloud PBX instances across their customer base.

YCM supports a reseller model where Hosting Users (resellers) manage their own portfolio of Cloud PBX instances and end customers. Each reseller has a subscription that defines their allocated capacity for extensions, concurrent calls, call recordings, and ultimate plans.

Service providers use YCM to centrally manage their reseller network, giving them visibility into each reseller’s subscription allocations and usage from a single administrative portal.

Data Collected

The Yeastar Central Management - Reseller - Version 1.1 collector retrieves unrated reseller subscription allocation data from Yeastar Central Management. The collector queries all users on the YCM platform, filters to Hosting Users (resellers) only, and retrieves each reseller’s subscription information.

The data collected depends on which collection switches are enabled in the collector configuration. Up to nine data categories can be collected independently:

Each enabled category produces one record per reseller, with the quantity reflecting the corresponding allocation or usage value. Records with a quantity of zero, null, or empty are automatically excluded.

Prerequisites

Before configuring this collector, ensure that:

• You have administrator access to the Yeastar Central Management portal
• The YCM API feature has been enabled in System > API within the YCM portal
• You have copied the Client ID and Client Secret values from System > API
• You have noted the host URL of your YCM portal (for example, https://ycm.example.com)
• You have access to the Varibill Source Collector configuration screen

Configuration Parameters

The parameters below are entered when configuring the collector in Varibill. They are grouped by function.

Connection Parameters

These parameters identify and authenticate against your Yeastar Central Management instance using OAuth 2.0 client credentials.

Collection Switches

These parameters control which types of allocation data are collected for each reseller. Set each switch to true to collect that data type, or false to skip it.

Product Identifier Parameters

Each enabled data category requires a Product Identifier value that maps to your Varibill product configuration.

Operational Parameters

These parameters control file management behavior.

Configuration Steps

Step 1: Prepare Yeastar Central Management

1. Log in to the YCM portal as an administrator.
2. Navigate to System > API.
3. Enable the API by turning on the API toggle.
4. Copy the Client ID value.
5. Copy the Client Secret value.
6. Note the host URL of your YCM portal.

For detailed instructions, see Enable YCM API.

Step 2: Configure the Collector in Varibill

1. In the Varibill User Interface, open the Source Collector configuration screen.

2. Enter the required field values under the Details tab:

   • Hosting Provider: Select Varibill Cloud
   • Source Collector Name: Select Yeastar Central Management - Reseller - Version 1.1

3. Enter the connection parameters:

   • YCM Host: The base URL of your YCM portal (for example, https://ycm.example.com)
   • YCM Client ID: The Client ID from the YCM API settings
   • YCM Client Secret: The Client Secret from the YCM API settings

4. Configure the collection switches. Set each switch to true for the data types you want to collect.

5. Enter the Product Identifier for each enabled data type. Ensure the values match your Varibill product configuration.

6. Save the collector configuration.

Step 3: Run the Collector

Run or schedule the collector according to your standard Source Collector execution process.

For detailed instructions, see: Configuring a New Cloud Source Collector

Troubleshooting

If the collector fails to connect to Yeastar Central Management, verify that:

• The YCM Host URL is correct and includes https:// with no trailing slash.
• The YCM Client ID is correct.
• The YCM Client Secret is valid and has not been regenerated since it was last configured.
• The YCM API feature is enabled in System > API within the YCM portal.
• No IP restriction rules in the YCM API settings are blocking the Varibill collector’s IP address.

If the collector connects successfully but returns no data, verify that:

• At least one collection switch is set to true.
• There are active Hosting Users (resellers) in your YCM environment.
• The resellers have subscription allocations associated with them.

Yeastar References

The following resources may assist with locating values or configuring your Yeastar Central Management API access.

Yeastar Documentation (External)

• Yeastar Website
• Yeastar Central Management Developer Guide
• Enable YCM API