HTTP/HTTPS
请求协议
EagletAPI / OpenAPI / base64上传文件
base64上传文件
接口地址:http://api.kittyhawks.cn/api/app.php?s=App.File.UploadByBase64
接口描述: 通过Base64编码后,上传图片、Word、Excel和PPT,以及PDF、TXT文本、HTML页面、Zip压缩包等文件。
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
file | 字符串 | 必须 | - | 数据源:POST | 上传 文件进行basse64编码后的数据。此参数必须使用POST方式传递,且必须进行base64编码后传递。 |
file_name | 字符串 | 必须 | - | 上传的文件名,需要带上文件扩展名。例如:file_name=文档.doc | |
file_type | 字符串 | 可选 | 上传的文件类型,用于纪录备忘。例如:file_type=doc |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
data.url | 字符串 | 成功上传时返回的图片URL,失败时为空 |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
file | 必须 | |
file_name | 必须 | |
file_type | 可选 |
客户端请求示例
{
"ret": 200,
"data": {
"url": "http://pro.api.phalapi.net/uploads/20200108/224921_28d4936c14ca5b405d35b3ed90dddb4a.jpg"
},
"msg": ""
}
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-11-01 07:48:12