Authentication

基本信息

接口描述:

Authenticate requests by setting the Authorization header with a valid API key.

We accept just the API key:

 "Authorization": "14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"

or Basic type and the API key:

"Authorization": "Basic 14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"

Make sure you've stored your API key somewhere secure and never share them publicly.

图片上传

基本信息

Path: /api/v2/upload

Method: POST

接口描述:

图片上传接口。

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type multipart/form-data
Authorization 参照 Authentication

Body

参数名称 参数类型 是否必须 示例 备注
smfile file 上传文件
format text json 输出的格式。可选值有 json、xml。默认为 json

返回数据

名称 类型 是否必须 默认值 备注 其他信息
success boolean 必须 请求状态
code string 必须 请求状态码

枚举: error,success

message string 必须 消息
data object 非必须
├─ width integer 必须 上传图片的宽度
├─ height integer 必须 上传图片的高度
├─ filename string 必须 文件名
├─ storename string 必须 储存名
├─ size integer 必须 图片大小
├─ path string 必须 路径
├─ hash string必须 图片删除HASH
├─ urlstring 必须 图片路径

format: uri

├─ delete string 必须 图片删除链接

format: uri

├─ page string 必须 图片专属链接

format: uri

RequestId string 必须 请求ID

上传历史

基本信息

Path: /api/v2/history

Method: GET

接口描述:

获得上传历史. 返回同一 IP 一个小时内上传的图片数据。

请求参数

Query

参数名称 是否必须 示例 备注
format json 输出的格式。可选值有 json、xml。默认为 json

返回数据

名称 类型 是否必须 默认值 备注 其他信息
success boolean 必须 状态
code string 必须
message string 必须 消息
data object [] 非必须

item 类型: object

├─ width integer 必须 宽度
├─ height integer 必须 高度
├─ filename string 必须 原始文件名
├─ storename string 必须 储存文件名
├─ size integer 必须 图片文件大小
├─ path string 必须 图片路径
├─ hash string 必须图片删除的HASH
├─ url string 必须 图片 URL
├─ delete string 必须 图片删除链接
├─ page string 必须 图片页面链接
RequestId string 必须 请求ID

用户上传历史

基本信息

Path: /api/v2/upload_history

Method: GET

接口描述:

提供 API Token,获得对应用户的所有上传图片信息。

请求参数

Headers

参数名称 参数值 是否必须 备注
Content-Type multipart/form-data
Authorization 参照 Authentication

返回数据

名称 类型 是否必须 默认值 备注 其他信息
success boolean 必须 状态
code string 必须
message string 必须 消息
data object [] 非必须

item 类型: object

├─ width integer 必须 宽度
├─ height integer 必须 高度
├─ filename string 必须 原始文件名
├─ storename string 必须 储存文件名
├─ size integer 必须 图片文件大小
├─ path string 必须 图片路径
├─ hash string 必须图片删除的HASH
├─ url string 必须 图片 URL
├─ delete string 必须 图片删除链接
├─ page string 必须 图片页面链接
RequestId string 必须 请求ID

用户基本信息

基本信息

Path: /api/v2/profile

Method: POST

接口描述:

提供 API Token,获得对应用户的基本信息。

请求参数

Headers

参数名称 参数值 是否必须 备注
Content-Type multipart/form-data
Authorization 参照 Authentication

返回数据

名称 类型 是否必须 默认值 备注 其他信息
success boolean 必须 状态
code string 必须
message string 必须 消息
data object [] 非必须

item 类型: object

├─ username string 必须 用户名
├─ email string 必须 邮件地址
├─ role string 必须 用户组名称
├─ group_expire string 必须 用户组过期时间
├─ email_verified number 必须 邮箱是否已经验证(0 表示未验证,1 表示已经验证)
├─ disk_usage string 必须 磁盘使用情况
├─ disk_usage_raw number 必须 磁盘使用情况(单位:Byte)
├─ disk_limit string 必须 总磁盘空间
├─ disk_limit_raw number 必须 总磁盘空间(单位:Byte)
RequestId string 必须 请求ID

图片删除

基本信息

Path: /api/v2/delete/{hash}

Method: GET

接口描述:

删除图片接口。

请求参数

路径参数

参数名称 示例 备注
hash lYz1Be2MZrJb3FhUpCaciHSIWd 图片删除 ID

Query

参数名称 是否必须 示例 备注
format json 输出的格式。可选值有 json、xml。默认为 json

返回数据

名称类型是否必须默认值备注其他信息
success boolean 非必须 状态
code string 非必须 状态码
message string 非必须 消息
RequestId string 非必须 请求ID

清除历史上传

基本信息

Path: /api/v2/clear

Method: GET

接口描述:

清除同一 IP 一小时内的历史上传信息。

请求参数

Query

参数名称 是否必须 示例 备注
format json 输出的格式。可选值有 json、xml。默认为 json

返回数据

名称 类型 是否必须 默认值 备注 其他信息
success boolean 非必须 请求状态
code string 非必须 请求状态码
message string 非必须 消息
RequestId string 非必须 请求ID