平台管理接口
平台 API 提供账户余额查询、实名状态查询、调用记录查询、产品列表查询、销售价格查询、在线购买及订单查询等功能。所有接口通过统一入口地址调用,使用全局应用凭据进行认证,仅限销售/管理员角色调用。
接口信息
| 项目 | 说明 |
|---|
| 接口地址 | POST /api.php |
| 认证方式 | 全局应用 APP ID / APP KEY |
| 角色限制 | 仅销售/管理员 |
| 请求格式 | application/json |
| 响应格式 | application/json |
通用请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|
action | string | 是 | 接口动作,见下方列表 |
app_id | string | 是 | 全局应用 APP ID |
app_key | string | 是 | 全局应用 APP KEY |
示例全局应用凭据(仅供文档参考,请替换为您的实际凭据):
app_id: 68B0FA47FEC9E7EBC4BF80F8
app_key: 2b901515a427b6c0b68f866eece70e0d2ecf687146022412
支持的 action 列表
| action | 功能 | 说明 |
|---|
balance | 查询余额 | 返回当前账户余额 |
realname_status | 查询实名状态 | 返回是否已实名认证 |
products | 查询产品列表 | 返回所有已启用产品 |
sales_prices | 查询销售价格 | 返回产品原价及销售价 |
orders | 查询订单 | 返回购买记录(含专属 APP 凭据) |
call_logs | 查询调用记录 | 返回 API 调用日志 |
buy | 在线购买 | 按次购买套餐,返回订单及专属凭据 |
通用响应结构
| 字段 | 类型 | 说明 |
|---|
code | int | 状态码,0 表示成功 |
msg | string | 提示信息 |
data | mixed | 响应数据,具体结构依接口而定 |
错误码
| 错误码 | 说明 |
|---|
| 0 | 成功 |
| 1001 | 参数错误 |
| 1002 | 认证失败 |
| 1003 | 无权限(非销售/管理员) |
| 1004 | 资源不存在 |
| 1005 | 余额不足 |
| 1006 | 内部错误 |
注意事项
所有请求必须使用 POST 方法,Content-Type 为 application/json
全局应用凭据需在云尚平台「应用管理」中创建,仅限销售/管理员角色使用
购买接口 buy 仅支持套餐制 API,买断制 API 不支持按次购买
订单查询和调用记录支持分页,limit 最大值为 50
所有金额字段均为 4 位小数精度
专属 APP ID 和 KEY 用于子应用登录和 API 调用,请妥善保管
接口返回 code 非 0 时,请根据 msg 提示排查问题