API Overview

Yeastar Central Management (YCM) provides REST APIs for seamless integration, allowing third-party clients to access and manage specific features or data of the YCM platform. You can configure your own API access settings and set API request rate limits for subordinate users, which ensures secure and controlled API usage.

API Access and Authentication

To use YCM APIs, you need to firstly enable API feature, obtain client credentials, and configure API settings on the YCM web portal.

For more information, see Developer Guide - Enable YCM API.

API Request Rate Limit

YCM supports setting API request rate limits for subordinate users (hosting users and resellers) using the token bucket algorithm. By specifying token bucket capacity and refill rate for subordinate users, you can easily control the user's API usage and effectively protect system resources from excessive or burst API requests.

For more information, see Limit API Request Rate for Subordinate Users.