请求结构
本文介绍 YCM API 的请求结构,包括请求头,请求方式和请求 URL。
注: 为保证数据隐私,YCM API 使用 HTTPS 协议,不支持未加密的 HTTP 协议。
请求示例
注: 需注意,每个发送到 YCM API 的请求,其头域 (Headers) 中都需要携带 User Agent (UA)
信息,以便星纵统一管理平台能够识别你的应用并响应请求。例如:
User-Agent: OpenAPI
。下面为 查询所有云 PBX
的请求示例。
GET /dm/open_api/v2/cloud_pbx/instances HTTP/1.1
Host: ycm.yeastar.com
User-Agent: OpenAPI
Authorization: Bearer {access_token}
GET
为 HTTP 请求方式。/dm/open_api/v2/cloud_pbx/instances
为查询所有云 PBX 的 API 请求地址。HTTP/1.1
为超文本传输协议。Host:ycm.yeastar.com
为 YCM 的域名。Authorization:Bearer {access_token}
用于认证请求。
认证请求
要发起 API 请求,你必须在 HTTP 请求头中添加授权信息,如此,授权服务器才允许你发起 REST API 请求。授权格式
Authorization: Bearer {access_token}
授权示例
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NzM0OSwicmVmcmVzaFZlcnNpb24iOjE2Mzg5NDM5MTJ9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjM4OTQ1NzEyLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJhNzgwMTA3Yi0wOGE1LTRmM2YtODY4Yi04NjFmMjUxOWUxMzAiLCJjbGllbnRfaWQiOiJrcDl5eW50bXVlc3VrNWpvV3ZNa1RiQ0J4cU82TEtSaCJ9.iX7FMOQQKuiKLCNO8wBtnKz6n3Ydv-OFtcut3j8JV-o
请求方式
API 支持以下请求方式:
HTTP 请求方式 | 用途 |
---|---|
GET | 查询信息。 |
POST | 添加对象或执行特定操作。 |
PUT | 更新或更改配置。 |
DELETE | 删除指定对象。 |
请求 URL
HTTP 请求 URL
格式如下:
{base_url}/{endpoint}
- {base_url}
- 本文档中所有请求 URL 都带有以下基本地址:
https://{ycm_domain}
- {endpoint}
- Endpoint,也称作 “路径”,表示 API 请求的具体地址。
- 授权请求的 Endpoint
格式为:
/dm/open_api/oauth/**
- 其他 API 请求的 Endpoint 格式为:
/dm/open_api/version/**
- 授权请求的 Endpoint
格式为: