ImgURL帮助文档【API】

最后更新:2019-06-06 10:20 清除缓存(若页面显示异常,请点此清除缓存)


ImgURL API接口说明


从v2.2版本开始,ImgURL提供API支持,并且默认启用,使用说明如下。


上传接口



请求参数


  • 参数名称:file (必须)
  • 类型:file
  • 支持的格式:jpg/jgeg/png/gif/bmp/webp


返回值


如果请求成功,返回结果如下


{
	"code": 200,
	"id": "15",
	"imgid": "9fde71fb50e4efe3",
	"relative_path": "\/imgs\/2019\/04\/9fde71fb50e4efe3.png",
	"url": "http:\/\/new.imgurl.org\/imgs\/2019\/04\/9fde71fb50e4efe3.png",
	"thumbnail_url": "http:\/\/new.imgurl.org\/imgs\/2019\/04\/9fde71fb50e4efe3_thumb.png",
	"width": 720,
	"height": 400
}


  • code: 状态码,200(成功),0(失败)
  • id: id(唯一)
  • imgid: 图片ID(唯一)
  • relative_path: 图片相对路径
  • url: 图片URL地址
  • thumbnail_url: 缩略图地址
  • width: 图片宽
  • height: 图片高


如果失败,返回结果为


{"code":0,"msg":"The filetype you are attempting to upload is not allowed."}


  • code: 状态码,200(成功),0(失败)
  • msg: 失败原因


其它参数


/api/upload默认返回json数据,同时还支持返回其它格式的URL地址,只需要后面追加参数即可


  • /api/upload/url : 返回图片URL地址
  • /api/upload/html : 返回图片HTML地址
  • /api/upload/bbcode : 返回图片BBCode地址
  • /api/upload/markdown : 返回图片Markdown地址


演示代码


<!DOCTYPE html>
<html lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
    <meta charset="utf-8" />
    <title>ImgURL上传测试</title>
    <meta name="generator" content="EverEdit" />
    <meta name="author" content="" />
    <meta name="keywords" content="" />
    <meta name="description" content="" />
</head>
<body>
    <form enctype="multipart/form-data" method="post" action="http://test.imgurl.org/api/upload" id="upform">
    <input type="file" name="file" class="up-file">
    <input type="submit" id="btn" value="开始上传" class="btn">
    </form>
</body>
</html>


探索发现


探索发现返回游客最新上传的图片,不显示管理员图片和可疑图片,说明如下。



返回的结果如下:


[{
	"id": "15",
	"imgid": "9fde71fb50e4efe3",
	"path": "\/imgs\/2019\/04\/9fde71fb50e4efe3.png",
	"thumb_path": "\/imgs\/2019\/04\/9fde71fb50e4efe3_thumb.png",
	"date": "2019-04-10 16:41",
	"compression": "0",
	"level": "unknown",
	"mime": "image\/png",
	"width": "720",
	"height": "400",
	"views": "1",
	"ext": ".png",
	"client_name": "yz.png"
}, {
	"id": "14",
	"imgid": "e28dc32685726892",
	"path": "\/imgs\/2019\/04\/e28dc32685726892.png",
	"thumb_path": "\/imgs\/2019\/04\/e28dc32685726892_thumb.png",
	"date": "2019-04-10 16:37",
	"compression": "0",
	"level": "unknown",
	"mime": "image\/png",
	"width": "816",
	"height": "373",
	"views": "0",
	"ext": ".png",
	"client_name": "snipaste_20180908_164604.png"
}]


返回参数说明


  • id: id
  • imgid: 图片唯一id
  • path: 图片绝对路径
  • thumb_path: 缩略图绝对路径
  • date: 图片上传日期
  • compression: 图片是否压缩,0没有压缩,1已经压缩
  • level: 图片等级,unknown未知,adult成人图片,everyone正常
  • mime: 图片MIME类型
  • width: 图片宽
  • height: 图片高
  • views: 图片浏览次数
  • ext: 扩展名
  • client_name: 图片原始名字


其它参数


除了默认返回游客最新的16张图片外,还支持对图片进行筛选,比如gif动态图片,只需要在/api/found追加参数即可。


  • /api/found/gif: 返回gif动图
  • /api/found/view: 返回浏览次数最高的图片
  • /api/found/view: 返回高清大图,像素高于1920 * 1080