Enable Yeastar Partner Portal API

Before you begin, you need to enable API access for your account on Yeastar Partner Portal.

Requirements

Your account manager has granted API access permission to your account.

Procedure

  1. Log in to Yeastar Partner Portal, go to System > API.
  2. At the right side of the API configuration page, turn on the switch.

  3. Obtain the API credentials.
    Credential Instruction
    Client ID

    In the Client ID field, click Copy and note down the client ID.
    Client Secret

    In the Client Secret field, do as follows:

    1. Click Reset.

    2. In the pop-up window, click Confirm to continue.

      A new client secret is generated and displayed in the window, you need to note down the client secret.

    3. Select the checkbox of the declaration and click OK.
  4. Optional: Set up IP restriction to prevent API access from unauthorized IP addresses.

    1. Select the checkbox of Client IP Restriction.
    2. Enter the permitted IP address and subnet mask.
    3. Optional: Click Add Layer to add more permitted IPs.
  5. Click Save.

Result

The API access for your account to Yeastar Partner Portal is enabled.

What to do next

Use the credentials to obtain an access token.