Enable YCM API

Before you begin, you need to enable API access on the Yeastar Central Management (YCM) web interface.

Procedure

  1. Log in to the Yeastar Central Management, go to System > API.
  2. Turn on the API on the top to enable the YCM API feature.

  3. Click to note down the API credentials.

    • Client ID: Read only. Client ID is part of the credential used to request API access token.
    • Client Secret: Read only. Client Secret is part of the credential used to request API access token.
      Note: If the API access token is stolen, you need to click to regenerate the Client Secret and request a new access token.
  4. Optional: For security purpose, you can set up IP restriction to prevent API access from unauthorized IP addresses.

    1. Select the checkbox of Client IP Restriction.
    2. Click Add, then enter the permitted IP address and subnet mask.
      Note:
      • You can add up to 5 restriction rules.
      • Only the permitted IP address can access YCM API.
  5. Click Save.