使用S系列 IPPBX API 之前，你需要先启用 PBX 的 API 功能、了解S系列 IPPBX API 的通信方式、API 请求结构、响应消息和 API 报告。
S系列 IPPBX 提供 二次开发接口（API）。第三方服务器与 PBX 通过 API 对接，你可以在第三方服务器上查询和编辑 PBX 的设置、实现多种呼叫功能。PBX 还会主动发送系统报告和通话报告到第三方服务器。
配置API之前，先启用PBX的API接口功能。
跨源资源共享 (CORS) 是一项浏览器安全特征，浏览器限制脚本内发起跨源 HTTP 请求。如果你无法访问 API 并收到错误响应提示 CORS 跨域错误，那么你需要启用 CORS。本文介绍如何为简单请求启用 CORS。
如果某个 IP 在短时间内，多次尝试登陆 API 接口失败，PBX 会将该 IP 拉入禁止名单，并将该 IP 类型标记为“API-IP”。如果该 IP 为受信任的 IP，你可以将这个 IP 从禁止名单列表中删除。
S系列 IPPBX 和第三方应用服务器的通信是相互的， 双方互为服务端和客户端。
本文介绍S系列 IPPBX 的 API 请求结构，包括通信协议、请求方式和请求地址说明。
S系列 IPPBX 返回的响应消息为 JSON 格式。
第三方服务器通过 API 接口与S系列 IPPBX 对接后，PBX 会主动发送 API 报告给第三方服务器。
Yeastar提供 API demo 软件，你可以通过 API demo 软件测试 API 接口。