DEVELOPER CENTER
API 接口文档
把证书站能力接入你的业务。这里整理了鉴权方式、请求格式与常用接口示例。
查看接口说明
API v1.0
HTTPS
统一使用 HTTPS + POST 表单请求,Token 放在请求体中。申请接口会产生真实业务操作;超时后请先查询记录,再决定是否重试。
POST
秒出 / 立即申请证书
/api/adddevice提交后立即尝试创建证书。是否成功及费用取决于账户、套餐、库存和站点配置。
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
token | string | 必填 | 用户中心的证书对接密钥,用于识别账户。 |
udid | string | 必填 | 设备 UDID;控制器接受 25 位或 40 位格式。 |
type | integer | 选填 | 证书池:0 公共池、1 独立池、2 独立池优先并回退公共池;默认按代码处理为 0。 |
warranty | integer | 选填 | 套餐编号:0 躺平、1 标准、2 加强、3 稳定、4 摆烂、5/6 高摆;是否可用以账户和站点配置为准。 |
deviceType | string | 选填 | 设备类型:iphone、ipad 或 mac;默认 iphone。 |
beizhu | string | 选填 | 申请备注。 |
apple_id | string | 选填 | 指定 Apple ID;仅在对应独立池场景生效。 |
resign | integer | 选填 | 补签场景传 1;普通申请不要传。 |
resign_kid | string | 选填 | 补签来源证书记录 ID;与 resign=1 配合使用。 |
响应参数
| 字段 | 类型 | 说明 |
|---|---|---|
code | integer | 1 表示成功;失败或处理中可能返回 0、1001、1002、1003 等,需同时检查 msg。 |
msg | string | 本次请求结果说明,例如“添加成功”或错误原因。 |
time | integer | 响应时间,Unix 时间戳;部分直接返回的分支可能不带此字段。 |
data.id | string | 证书记录 ID,可用于后续查询。 |
data.pname | string | 证书名称。 |
data.pool | integer | 证书池标记:0 公共池、1 独立池。 |
data.addtime | integer | 记录时间,Unix 时间戳。 |
data.mobileprovision | string | 描述文件 Base64;尚未生成时可能为空字符串。 |
data.p12 | string | P12 证书 Base64。属于敏感凭证,请妥善保管。 |
data.error | string | 部分失败响应会携带的错误原因。 |
data.sites | string | 部分失败响应会标明失败来源或证书池。 |
请求示例
curl -X POST 'https://你的站点域名/api/adddevice' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'token=替换为用户自己的API_TOKEN' \
--data-urlencode 'udid=替换为设备UDID' \
--data-urlencode 'type=0' \
--data-urlencode 'warranty=1' \
--data-urlencode 'deviceType=iphone'token=替换为用户自己的API_TOKEN
udid=替换为设备UDID
type=0
warranty=1
deviceType=iphone响应示例注释为字段说明,非严格 JSON
{
"code": 1, // 成功标志
"msg": "添加成功", // 处理结果
"time": 1792100000, // Unix 时间戳(秒)
"data": {
"id": "9526IS", // 证书记录 ID
"pname": "Anthonie E Smith", // 证书名称
"pool": 0, // 证书池:0 公共池,1 独立池
"addtime": 1792100000, // 添加时间
"mobileprovision": "Base64描述文件", // 描述文件内容
"p12": "Base64P12文件" // P12 证书内容
}
}{
"code": 0, // 失败标志
"msg": "目前暂无库存,请稍后重试", // 失败原因
"time": 1792100000, // Unix 时间戳(秒)
"data": {
"error": "目前暂无库存,请稍后重试" // 详细错误
}
}POST
预约申请证书
/api/addyydevice创建预约记录;预约成功不代表描述文件已经生成。常规模式下 iPad 预约受限,具体以站点配置为准。
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
token | string | 必填 | 用户中心的证书对接密钥,用于识别账户。 |
udid | string | 必填 | 设备 UDID;控制器接受 25 位或 40 位格式。 |
type | integer | 选填 | 证书池:0 公共池、1 独立池、2 独立池优先并回退公共池。 |
warranty | integer | 选填 | 套餐编号:0 躺平、1 标准、2 加强、3 稳定、4 摆烂、5/6 高摆。 |
deviceType | string | 选填 | iphone、ipad 或 mac;默认 iphone。 |
beizhu | string | 选填 | 申请备注。 |
apple_id | string | 选填 | 指定 Apple ID;仅在对应独立池场景生效。 |
resign | integer | 选填 | 补签场景传 1;普通申请不要传。 |
resign_kid | string | 选填 | 补签来源证书记录 ID;与 resign=1 配合使用。 |
响应参数
| 字段 | 类型 | 说明 |
|---|---|---|
code | integer | 1 表示预约受理或成功;库存不足等情况可能返回 0、1001、1002、1003,以实际 msg 为准。 |
msg | string | 预约结果说明;不同站点或处理阶段可能返回不同文案。 |
time | integer | 响应时间,Unix 时间戳;部分直接返回的分支可能不带此字段。 |
data.id | string | 预约/证书记录 ID,用于后续查询。 |
data.pname | string | 证书名称。 |
data.pool | integer | 证书池标记:0 公共池、1 独立池。 |
data.addtime | integer | 记录时间,Unix 时间戳。 |
data.mobileprovision | string | 描述文件 Base64;预约处理中通常为空字符串。 |
data.p12 | string | P12 证书 Base64;部分预约状态下可能为空或已有值。 |
data.error | string | 部分失败响应会在此返回失败原因。 |
data.sites | string | 部分失败响应会标明失败来源或证书池。 |
请求示例
curl -X POST 'https://你的站点域名/api/addyydevice' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'token=替换为用户自己的API_TOKEN' \
--data-urlencode 'udid=替换为设备UDID' \
--data-urlencode 'type=0' \
--data-urlencode 'warranty=1' \
--data-urlencode 'deviceType=iphone'token=替换为用户自己的API_TOKEN
udid=替换为设备UDID
type=0
warranty=1
deviceType=iphone响应示例注释为字段说明,非严格 JSON
{
"code": 1, // 成功标志
"msg": "添加成功", // 预约受理结果
"time": 1792100000, // Unix 时间戳(秒)
"data": {
"id": "9526IS", // 预约/证书记录 ID
"pname": "Anthonie E Smith", // 证书名称
"pool": 0, // 证书池:0 公共池,1 独立池
"addtime": 1792100000, // 预约时间
"mobileprovision": "", // 预约处理中可能为空
"p12": "" // 预约处理中可能为空
}
}{
"code": 0, // 失败标志
"msg": "库存不足,请稍后重试", // 失败原因
"time": 1792100000, // Unix 时间戳(秒)
"data": {
"sites": "本站", // 失败来源
"error": "库存不足,请稍后重试" // 详细错误
}
}POST
查询证书记录
/api/getalldevice查询当前 Token 用户的证书/预约记录列表,不返回证书文件内容。
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
token | string | 必填 | 用户中心的证书对接密钥。 |
pool | integer | 选填 | 证书池筛选:0 公共池、1 独立池;不传返回全部证书池记录。 |
type | integer | 选填 | 记录类型筛选:0 秒出记录、1 预约记录;不传返回全部类型。 |
响应参数
| 字段 | 类型 | 说明 |
|---|---|---|
code | integer | 1 表示查询成功;错误时请读取 msg。 |
msg | string | 查询结果说明。 |
time | integer | 响应生成时间,Unix 时间戳。 |
data.total | integer | 符合条件的记录总数。 |
data.list | array | 记录数组;无记录时为空数组。 |
data.list[].udid | string | 设备 UDID。 |
data.list[].id | string | 证书记录 ID。 |
data.list[].cername | string | 证书名称。 |
data.list[].pool | integer | 证书池:0 公共池、1 独立池。 |
data.list[].type | integer | 记录类型:0 秒出、1 预约。 |
data.list[].addtime | string | 记录创建时间,格式 Y-m-d H:i:s。 |
请求示例
curl -X POST 'https://你的站点域名/api/getalldevice' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'token=替换为用户自己的API_TOKEN' \
--data-urlencode 'pool=0' \
--data-urlencode 'type=0'token=替换为用户自己的API_TOKEN
pool=0
type=0响应示例注释为字段说明,非严格 JSON
{
"code": 1, // 成功标志
"msg": "返回成功", // 查询结果
"time": 1792100000, // Unix 时间戳(秒)
"data": {
"total": 1, // 记录总数
"list": [ // 证书/预约记录列表
{
"udid": "00008030-001234567890002E", // 设备 UDID
"id": "9526IS", // 证书记录 ID
"cername": "Anthonie E Smith", // 证书名称
"pool": 0, // 证书池:0 公共池,1 独立池
"type": 0, // 记录类型:0 秒出,1 预约
"addtime": "2026-10-16 12:00:00" // 创建时间
}
]
}
}{
"code": 0, // 失败标志
"msg": "token不正确", // 失败原因
"time": 1792100000, // Unix 时间戳(秒)
"data": [] // 当前接口错误时返回空数组
}POST
查询证书文件
/api/getcertificate按当前 Token 用户的证书记录 ID 或设备 UDID 查询证书文件及状态。接口按客户端 IP 限流,源码限制为每分钟最多 10 次。
证书文件属于敏感材料
响应可能包含 P12 和描述文件的 Base64 内容。请勿将 Token 或证书文件放入公开客户端、日志或工单。
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
token | string | 必填 | 用户中心的证书对接密钥。 |
id | string | 条件必填 | 证书记录 ID;与 udid 至少传一个。传入时优先按 ID 查询。 |
udid | string | 条件必填 | 设备 UDID;与 id 至少传一个。 |
query_mode | integer | 选填 | 传 1 时启用查询模式;描述文件尚未生成时不触发自动出证。 |
响应参数
| 字段 | 类型 | 说明 |
|---|---|---|
code | integer | 1 表示查询成功;错误分支请读取 msg。 |
msg | string | 查询结果或错误说明。 |
time | integer | 响应时间,Unix 时间戳;标准响应包含此字段。 |
data.id | string | 证书记录 ID。 |
data.pname | string | 证书名称。 |
data.addtime | integer | 记录时间,Unix 时间戳。 |
data.pool | integer | 证书池标记,来自记录的池字段。 |
data.type | integer | 证书记录类型。 |
data.mobileprovision | string | 描述文件 Base64;尚未生成时为空字符串。 |
data.p12 | string | P12 证书 Base64。 |
data.state | boolean/string | 证书状态标志;具体含义以当前证书处理状态为准。 |
data.warranty | boolean | 是否处于售后状态。 |
data.warranty_time | integer | 售后/有效期时间戳。 |
data.shtype | integer | 售后套餐类型编号。 |
请求示例
curl -X POST 'https://你的站点域名/api/getcertificate' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'token=替换为用户自己的API_TOKEN' \
--data-urlencode 'id=替换为证书记录ID' \
--data-urlencode 'query_mode=1'token=替换为用户自己的API_TOKEN
id=替换为证书记录ID
query_mode=1响应示例注释为字段说明,非严格 JSON
{
"code": 1, // 成功标志
"msg": "返回成功", // 查询结果
"time": 1792100000, // Unix 时间戳(秒)
"data": {
"id": "9526IS", // 证书记录 ID
"pname": "Anthonie E Smith", // 证书名称
"addtime": 1792100000, // 添加时间
"pool": 0, // 证书池:0 公共池,1 独立池
"type": 0, // 证书记录类型
"mobileprovision": "Base64描述文件", // 描述文件内容
"p12": "Base64P12文件", // P12 证书内容
"state": true, // 证书状态
"warranty": false, // 是否售后
"warranty_time": 0, // 售后/有效期时间戳
"shtype": 0 // 售后套餐类型
}
}{
"code": 0, // 失败标志
"msg": "token不正确", // 失败原因
"time": 1792100000, // Unix 时间戳(秒)
"data": {
"error_time": 1792100000, // 错误发生时间
"error": "token不正确" // 详细错误
}
}POST
查询账户余额
/api/getbalance只读接口,仅返回当前 Token 对应用户的账户余额和可用设备额度。
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
token | string | 必填 | 用户中心的证书对接密钥。 |
响应参数
| 字段 | 类型 | 说明 |
|---|---|---|
code | integer | 1 表示获取成功;错误时读取 msg。 |
msg | string | 接口处理结果说明。 |
time | integer | 响应时间,Unix 时间戳。 |
data.money | number/string | 账户余额,字段来自用户账户 money。 |
data.score | number/string | 设备额度,字段来自用户账户 score。 |
请求示例
curl -X POST 'https://你的站点域名/api/getbalance' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'token=替换为用户自己的API_TOKEN'token=替换为用户自己的API_TOKEN响应示例注释为字段说明,非严格 JSON
{
"code": 1, // 成功标志
"msg": "获取成功", // 查询结果
"time": 1792100000, // Unix 时间戳(秒)
"data": {
"money": "100.00", // 账户余额
"score": 20 // 可用设备额度
}
}{
"code": 0, // 失败标志
"msg": "token不正确", // 失败原因
"time": 1792100000, // Unix 时间戳(秒)
"data": [] // 当前接口错误时返回空数组
}