Enable API feature on Yeastar Workplace

To use Yeastar Workplace API, you need to enable API access on Yeastar Workplace admin portal first.

Prerequisites

  • Make sure that your Yeastar Workplace plan is Standard Plan or Pro Plan.
  • You have obtained the public IP address of the third-party application to be integrated.

Procedure

  1. Log in to Yeastar Workplace admin portal.

  2. Go to Integration, click Enable beside API.

  3. In the pop-up window, note down the API credentials for later use.

  4. In the IP Address Allowlist section, enter the public IP address of the third-party application.
    Tip: You can click Add to add more public IP addresses of the servers that need to request Yeastar Workplace APIs.

  5. Click Save.
    Note: The Webhook section is used to set up webhook event notification, so that third-party applications can receive notifications when specific events occur on Yeastar Workplace. For more information about the configuration, see Set up Webhook Event Notification.

Result

The API feature is enabled.