📌 简介
本接口用于获取用户协议相关文档信息,包含服务条款、隐私政策等核心内容。
通过 /api-reference/agreement
路径可访问当前协议说明,如需了解其他API请查看API总览。
📦 请求说明
方法 | 路径 | 描述 |
---|---|---|
GET | /api-reference/agreement |
获取协议文档 |
📝 参数列表
version
(可选): 协议版本号,如不指定将返回最新版language
(可选): 语言标识,支持zh
/en
(默认zh
)
⚠️ 注意事项
- 请确保使用 HTTPS 访问以保障数据安全
- 响应数据为 JSON 格式,包含
status
和content
字段 - 若请求失败,
status
会返回错误码(如 404、500)
📱 示例代码
使用 curl
curl -X GET "https://api.example.com/api-reference/agreement?version=1.0"
使用 Python
import requests
response = requests.get("https://api.example.com/api-reference/agreement")
print(response.json())
📌 响应示例
{
"status": "success",
"content": "本协议受《服务条款》约束,详见[协议详情](/api-reference/agreement/detail)"
}