API 2.0
蒲公英开放 API 2.0 概览:接口说明、鉴权方式、通用参数与错误码对照。
接口说明
利用蒲公英提供的接口,您可以将应用上传托管、安装等功能接入到自己的系统中,并通过数据接口获取各种应用数据,便于内测应用的分发与管理。
本页面展示的是最新版本 API 2.0,旧版本 API 1.0 将不再维护和更新。
API 分组导航
按功能划分,API 2.0 可分为以下几组。每组接口的详细说明请查看对应页面。
| 分组 | 涵盖内容 |
|---|---|
| 上传与发布 | 快速上传 App、HarmonyOS 证书与 Hsp 文件、旧版上传接口 |
| 安装应用 | 通用安装接口、iOS 应用内安装 |
| 应用信息 | 获取、修改 App 详情,查看自己上传的应用,通过短链接获取信息 |
| 版本管理 | 获取所有版本、设置/取消最新版本、检测更新 |
| 应用分组 | 列出与查看用户的 App 分组 |
| 反馈信息 | 反馈列表、反馈详情 |
| 证书管理 | 证书列表 |
| 删除接口 | 删除应用、删除版本 |
鉴权说明
大部分 API 都需要鉴权。您可以登录蒲公英后台的 API 信息页面 获取 API Key,然后在需要鉴权的 API 中,以 POST 方式传入以下参数:
| 参数 | 说明 |
|---|---|
| _api_key | API Key,用来识别 API 调用者的身份。如无特别说明,每个接口中都需要包含此参数。对同一个蒲公英注册用户来说,这个值是固定的。 |
API 调用说明
发送数据格式请设置为 Content-Type: application/x-www-form-urlencoded,如无特别说明,请求方式均为 POST,返回数据格式为 JSON。
以下是通用参数的概念解释:
| 参数 | 说明 |
|---|---|
| appKey | 独立 App 的唯一标识符。例如某 App 上传了三个版本,这三个版本具有相同的 appKey。可以在 App 管理页面中找到 appKey,也可以从某些 API 返回结果中获取。 |
| buildKey | 独立 App 版本的唯一标识符。例如某 App 上传了三个版本,这三个版本具有不同的 buildKey。可以从某些 API 的返回结果中获取。 |
错误码含义
| 错误码 | 说明 |
|---|---|
| 1001 | _api_key 不能为空 |
| 1002 | _api_key 错误 |
| 1003 | 同步用户信息到 Tracup 出错信息 |
| 1007 | 搜索词太短 |
| 1008 | Build Key 和 appKey 不能同时为空 |
| 1009 | 没有找到该 App 相关信息 |
| 1010 | App Key 不能为空 |
| 1011 | Build Id 不能为空 |
| 1012 | User key 不能为空 |
| 1013 | 没有找到该用户 |
| 1014 | 应用类型不能为空 |
| 1015 | 文件或 App 类型错误 |
| 1016 | 无效的包名 |
| 1017 | 短链接已被使用或者不符合规范 |
| 1018 | App 数量超过套餐的上限 |
| 1019 | 实名认证身份照片不全,请上传身份证正面、背面及手持身份照片 |
| 1020 | 用户被禁止上传 |
| 1021 | 文件无效 |
| 1022 | 文件过大 |
| 1023 | build key 不能为空 |
| 1024 | 发布范围超过限制 |
| 1025 | 文件上传失败 |
| 1026 | 无效文件,文件类型错误 |
| 1027 | 应用名称长度不符合规范 |
| 1028 | 未找到应用的标识符 |
| 1029 | 短链接已被使用或不符合规范 |
| 1030 | 发布企业签名数量超过套餐最大值 |
| 1031 | 短链接不能为空 |
| 1032 | 短链接无效 |
| 1033 | 只能修改自己的应用 |
| 1035 | 修改的字段超过限制 |
| 1036 | 修改内容不能为空 |
| 1037 | 图片必须以数组的形式上传 |
| 1038 | 图片数据不能为空 |
| 1039 | 应用截图最多不能超过 5 张 |
| 1040 | 应用截图上传失败 |
| 1041 | 应用截图 key 不能为空 |
| 1042 | 反馈内容不能为空 |
| 1043 | 反馈内容过长,不能超过 200 字 |
| 1044 | 添加反馈出错 |
| 1045 | 无效的 user Key |
| 1047 | 该应用收费,请使用手机进行安装 |
| 1048 | 应用已过期 |
| 1049 | 应用下载次数已用完 |
| 1050 | 密码错误 |
| 1051 | 应用违规 |
| 1052 | 应用仅认证用户可以下载 |
| 1053 | 下载速度超过限制 |
| 1054 | 今日下载次数已用完 |
| 1055 | 无效的 api key |
| 1056 | 请在 iOS 系统中打开该链接 |
| 1057 | 同步专家测试企业签名应用参数错误 |
| 1058 | 解析应用出错 |
| 1059 | 废弃的方法 |
| 1060 | 请输入你的邮箱 |
| 1061 | 请输入你的密码 |
| 1062 | 用户名或者密码不正确 |
| 1063 | 该邮箱已存在 |
| 1064 | 请输入你的用户名 |
| 1065 | 用户名不能超过 15 个字符 |
| 1066 | 请输入你的姓名 |
| 1067 | 请输入你的公司 |
| 1068 | 请输入你的职业 |
| 1069 | 该手机号码已存在 |
| 1070 | 请输入验证码 |
| 1071 | 验证码无效 |
| 1072 | 该邮箱不存在 |
| 1073 | 请输入正确的账户信息 |
| 1075 | App group key 不能为空 |
| 1076 | App key 不正确 |
| 1079 | 录音上传失败 |
| 1080 | 反馈失败 |
| 1081 | 非法请求 |
| 1082 | Feedback Key 不能为空 |
| 1083 | 反馈信息未找到 |
| 1084 | 日志信息不能为空 |
| 1085 | 系统类型不正确 |
| 1089 | 获取平台参数不能为空 |
| 1090 | 平台参数为 windows 或者 mac |
| 1091 | 版本参数不对 |
| 1092 | 版本信息没有找到 |
| 1093 | 没有找到信息 |
| 1094 | app group key 不正确 |
| 1095 | 应用名称过长 |
| 1096 | 错误的方法 |
| 1097 | 签名错误 |
| 1098 | Api 请求达到每小时的上限 |
| 1099 | 更新 App 失败 |
| 1100 | 没有找到 App 分组信息 |
| 1102 | 请输入邮箱验证码 |
| 1103 | 您输入的验证码不正确 |
| 1104 | 您输入的邮箱地址无效 |
| 1105 | 该账号已存在 |
| 1106 | 真实姓名的长度必须小于 15 |
| 1107 | 请填写密码 |
| 1108 | 请正确填写您的手机号码 |
| 1109 | 请输入您的 6 位验证码 |
| 1110 | 注册失败 |
| 1111 | 请输入你的账号 |
| 1112 | 该手机号码绑定多个账号,请使用密码进行登录 |
| 1113 | 请填写邮箱地址 |
| 1115 | 用户不存在 |
| 1116 | 手机号码或密码不正确 |
| 1117 | 邮箱地址或密码不正确 |
| 1118 | 请输入手机号码 |
| 1120 | 每次发送短信的间隔必须在 30 秒以上 |
| 1121 | 验证失败 |
| 1122 | 权限不足 |
| 1123 | 统计类型出错 |
| 1124 | 授权信息失败 |
| 1125 | 绑定已有账号 |
| 1126 | 邮箱未更改 |
| 1127 | 邮箱地址已存在 |
| 1128 | 权限不足,只能删除自己上传的应用 |
| 1129 | 该账号已绑定微信号,请重新输入账号 |
| 1130 | 请输入您的新密码 |
| 1131 | 请再次输入密码 |
| 1132 | 两次输入密码不一致,请重新输入 |
| 1133 | JSCode 不能为空 |
| 1134 | JSCode 无效 |
| 1135 | 没有找到资质文件 |
| 1136 | 删除资质文件失败 |
| 1137 | 上传资质文件出错 |
| 1138 | 文件数量超过最大限制 |
| 1139 | 一种类型只能上传两张文件 |
| 1140 | 添加资质文件失败 |
| 1141 | 交易类型不能为空 |
| 1142 | 当前版本不可隐藏 |
| 1143 | encryptedData 和 iv 不能为空 |
| 1144 | 请输入安装开始时间及结束时间 |
| 1145 | 安装结束时间必须大于开始时间 |
| 1148 | 请上传身份证正面照片 |
| 1149 | 请上传身份证反面照片 |
| 1150 | 请上传手持身份证照片 |
| 1151 | 企业名称不能为空 |
| 1152 | 营业执照号码不能为空 |
| 1153 | 请上传营业执照照片 |
| 1154 | 省份不能为空 |
| 1155 | 城市不能为空 |
| 1156 | 当日自动审核次数已用完 |
| 1157 | 自动审核未通过 |
| 1158 | 图片不能大于 10M |
| 1159 | 图片不能小于 15k |
| 1160 | 图片类型不正确 |
| 1161 | fileType 不能为空 |
| 1162 | 名称不能为空 |
| 1163 | 描述不能为空 |
| 1164 | appKeys 不能为空 |
| 1165 | 描述文字太长 |
| 1166 | 分组名称不符合规则 |
| 1167 | 分组的应用,至少两个 |
| 1168 | 网址后缀不能为空 |
| 1169 | 新号码和旧号码不能一样 |
| 1170 | 手机号码错误 |
| 1171 | 真实姓名不能为空 |
| 1172 | 身份证号不能为空 |
| 1173 | 真实姓名不匹配 |
| 1174 | 身份证号不匹配 |
| 1175 | 发布时间不能为空 |
| 1176 | 请输入正确的发布时间 |
| 1177 | 获取应用信息失败 |
| 1178 | 应用类型不能为空 |
| 1179 | 不能合并空白应用 |
| 1180 | 应用已合并 |
| 1181 | 请合并 iOS 应用 |
| 1182 | 请合并 Android 应用 |
| 1183 | 必须是自己的应用 |
| 1184 | 不能和自己合并 |
| 1185 | 图标已存在不等上传图标 |
| 1186 | 应用未发布 |
| 1187 | 请升级您的版本 |
| 1188 | 发生错误 |
| 1189 | 暂时不能更改文件 |
| 1190 | 请上传文网文 |
| 1191 | 请上传 ICP 许可证 |
| 1192 | 上传软件著作权登记证 |
| 1193 | 上传营业执照 |
| 1194 | 请上传金融牌照 |
| 1195 | 请上传其他证件 |
| 1196 | 请上传有关资质文件 |
| 1197 | 请上传信息网络传播视听节目许可证 |
| 1198 | 请重新上传审核不通过的文件 |
| 1199 | 相关文件数目不匹配 |
| 1200 | 申诉理由不能少于 20 个字符,不能多于 500 字符 |
| 1201 | 申诉图片不能大于 5 张 |
| 1202 | 不能删除所有可下载版本,如需删除应用,可在设置中删除应用 |
| 1203 | 不能删除所有显示的版本 |
| 1212 | 渠道短链接无效,请检查短链接 |