API Request Overview

This topic introduces the communication protocols, communication port, and request flow of the Yeastar P-Series Cloud Edition API.

Communication protocols

Yeastar P-Series Cloud Edition supports GET and POST request over HTTPS protocol.

Communication port

The API communication port is the same as the web access port of PBX, namely the HTTPS port 443.

API request flow

After a third-party application is connected to Yeastar P-Series Cloud Edition, the third-party application acts as the client, while the PBX acts as the server.

The workflow of the API request is shown below:

Every time the third-party application sends an API request to the PBX, a new TCP connection is established. After the PBX returns a response to the application, the TCP connection is closed.

For the first request, the application needs to send credentials to request for an access token. The PBX verifies the credentials and returns an access token. In the subsequent requests, the application should include the access token in every request for authenticated API calls. The PBX validates the access token and returns a response with requested resources.