Demo - v20161028
SOOGIF API 概述
SOOGIF 是国内首家gif动图搜索引擎网站，应用开发者可以使用SOOGIF API 接口功能，丰富自身应用图库，快速开发动图场景功能
更新说明
V1.5.0版本：
1.正式公开发布
2.修复细微的问题
---
V1.4.1版本：
1.增加mp4与webp格式返回
2.增加热门搜索词接口
3.修复返回图片标题为空问题
4.修复其他各类问题，优化搜索效率
---
V1.3.0版本：
1.分类接口大改版
- 分类及栏目新增封面图
- 增加分类及栏目更新时间，第一时间获取更新
- 其他分类接口参数增加
2.增加热门图片接口，可直接调用最近热门图片
---
V1.2.0版本：
返回图片链接支持https协议
API返回数据增加原图宽高参数
---
V1.1.1版本：
优化分类接口，将分类划分为两个层级，调用方式为分类——栏目——栏目图片
---
V1.0.3版本：
提供减帧图片fixedUrl，选取关键帧新建gif图片，调用可以大大减少缩略显示时的体积和加载速度，内存占用变得更少，使用更流畅
分类动图接口
SOOGIF拥有专业的编辑团队打造官方分类，实时更新热点事件和表情开发者可以直接使用 SOOGIF 官方内容分类，也可以根据自身需求调用内容分类
热门动图接口
SOOGIF热门动图接口可第一时间获取全网最热门的动图，获得最新最快的图片内容更新
搜索接口
搜索接口可以通过文字匹配调用动图搜索，开发者可根据自身应用场景，自由调用库中动图
动图处理
API内根据不同场景，对尺寸、大小做了相应优化，通关简单的参数调整可根据需求自由调用、缩放、裁剪适合动图
接入步骤与说明
1. 开发者在线申请
请在首页申请入口填写相应申请需求，我们会第一时间联系你
2. 获取应用ID
通过申请之后，我们会为内测产品提供唯一的应用ID，根据规则加密后在调用接口中填写使用，请保管好调用ID不要泄露
3. 开始使用
根据接口调用指南接入使用SOOGIF API 内容
4. 接入声明
接入API应用须在使用界面可视部分展示 SOOGIF 露出（详细可与官方人员联系）
接入API即视为同意本文末尾《SOOGIF用户使用协议》所述相关条款
SOOGIF API 所用到的素材部分为网络开放性图片，其余为SOOGIF官方制作，使用者不得将官方制作的图片给第三方使用，若有则收回调用接口权限
接口调用指南
接口列表
1. 搜索接口
desc
根据用户输入的【搜索词】查询匹配的gif动图
uri
/oapi/backend/image/search
请求方式
GET
参数
# 普通参数
text:xxx // [非空][字符串] 搜索词
type:xxx // [非空][字符串] 图片类型
## type说明
1. 动图压缩：将返回的动图压缩到2M、1M、500K内 type=S_2M[可选：1M、500K]
2. 动图缩放：将返回动图按宽度缩放 type=Z_200x100[可任意调整数值]
3. 动图裁剪：按指定大小缩放后裁剪动图中心位置内容type=C_200x100[可任意调整数值]
# 分页参数
pageNumber:xxx // [可空][数字，默认：1] 页码
pageSize:xxx // [可空][数字，默认：10] 每页条数
# 验证参数
timestamp:xxx // [非空][数字] 当前系统13位时间戳
scope:xxx // [非空][字符串] 代表公司
sign:xxx // [非空][字符串] 接口签名 md5(text+scope+timestamp+SALT) 拼接时不需要中间“+”符号
返回格式(json)
成功返回
{
code:200,
msg:success,
data:{
pagination:{
pageNumber:xxx, // 页码
pageSize:xxx, // 每页条数
pageCount:xxx, // 总页数
allCount:xxx // 总条数
},
images:[
{
serialCode:xxx, // 序列号
title:xxx, // 标题
url:xxx, // 原图片URL
fixedUrl:xxx, // 减帧后的gif动图，默认3帧，可用作缩略图
mp4Url:xxx // mp4格式Url
webpUrl:xxx // webp格式Url
size:xxx, // 原图大小
height:xxx, // 原图高度
width:xxx // 原图宽度
},{},{} ...
]
}
}
错误返回
{code:920,msg:"auth"} // sign出错
{code:900,msg:"xxx"} // 系统异常，详细信息请查看msg
说明
其他错误码说明参考文档
示例
api.soogif.com/oapi/backend/image/search?text=%E6%90%9E%E7%AC%91&&type=S_2M&scope=test×tamp=1478749249000&sign=97106164f01f57473e78dbd2148ac729
2. 查询分类
desc
查询分类列表
uri
/oapi/backend/class/list
请求方式
GET
参数
# 普通参数
无
# 验证参数
timestamp:xxx // [非空][数字] 当前系统13位时间戳
scope:xxx // [非空][字符串] 代表公司
sign:xxx // [非空][字符串] 接口签名 md5(scope+timestamp+SALT)拼接时不需要中间“+”符号
返回格式(json)
成功返回
{
code:200,
msg:success,
classnum:1, // 分类总数量
data:{
classes:[
{
id:xx, // 分类ID
title:xx, // 标题
cover:xx, // 分类封面
description:xx, // 分类描述
updatetime:xx // 最后更新时间
},{},{},{} ...
]
}
}
错误返回
{code:920,msg:"auth"} // sign出错
{code:900,msg:"xxx"} // 系统异常，详细信息请查看msg
说明
其他错误码说明参考文档
示例
api.soogif.com/oapi/backend/class/list?scope=test×tamp=1478749249000&sign=97106164f01f57473e78dbd2148ac729
3. 查询栏目
desc
查询栏目列表
uri
/oapi/backend/column/list
请求方式
GET
参数
# 普通参数
classId:xxx // [非空][数字] 分类ID
# 验证参数
timestamp:xxx // [非空][数字] 当前系统13位时间戳
scope:xxx // [非空][字符串] 代表公司
sign:xxx // [非空][字符串] 接口签名 md5(scope+timestamp+SALT)拼接时不需要中间“+”符号
返回格式(json)
成功返回
{
code:200,
msg:success,
columnNum:31, //分类下栏目总数量
pagination:{
updatetime:xx, //分类更新时间
description:xx, //分类描述
cover:xx //分类封面图
}
data:{
columns:[
{
id:xx, // 栏目ID
title:xx, // 标题
cover:xx, // 栏目封面
updatetime:xx, // 最后更新时间
},{},{},{} ...
]
}
}
错误返回
{code:920,msg:"auth"} // sign出错
{code:900,msg:"xxx"} // 系统异常，详细信息请查看msg
说明
其他错误码说明参考文档
示例
api.soogif.com/oapi/backend/column/list?scope=test×tamp=1478749249000&sign=97106164f01f57473e78dbd2148ac729
4. 查询图片列表
desc
查询栏目下的图片列表
uri
/oapi/backend/column/image/list
请求方式
GET
参数
# 普通参数
columnId:xxx // [非空][数字] 栏目ID
type:xxx // [非空][字符串] 图片类型
## type说明
1. 动图压缩：将返回的动图压缩到2M、1M、500K内 type=S_2M[可选：1M、500K]
2. 动图缩放：将返回动图按宽度缩放 type=Z_200x100[可任意调整数值]
3. 动图裁剪：按指定大小缩放后裁剪动图中心位置内容type=C_200x100[可任意调整数值]
# 分页参数
pageNumber:xxx // [非空][数字] 页码
pageSize:xxx // [非空][数字] 每页条数
# 验证参数
timestamp:xxx // [非空][数字] 当前系统13位时间戳
scope:xxx // [非空][字符串] 代表公司
sign:xxx // [非空][字符串] 接口签名 md5(columnId+scope+timestamp+SALT)拼接时不需要中间“+”符号
返回格式(json)
成功返回
{
code:200,
msg:success,
data:{
pagination:{
pageNumber:xxx, // 页码
pageSize:xxx, // 每页条数
pageCount:xxx, // 总页数
allCount:xxx // 总条数
cover:xx // 栏目封面
updatetime:xx // 最后更新时间
},
images:[
{
serialCode:xxx, // 序列号
title:xxx, // 标题
url:xxx, // 图片URL
fixedurl:xxx // 减帧图片URL
mp4Url:xxx // mp4格式Url
webpUrl:xxx // webp格式Url
size:xxx, // 原图大小
md5:xxx, // 图片MD5
height:xxx, // 原图高度
width:xxx // 原图宽度
},{},{} ...
]
}
}
错误返回
{code:920,msg:"auth"} // sign出错
{code:900,msg:"xxx"} // 系统异常，详细信息请查看msg
说明
其他错误码说明参考文档
示例
api.soogif.com/oapi/backend/column/image/list?scope=test&columnId=15×tamp=1478749249000&sign=97106164f01f57473e78dbd2148ac729
5. 查询热门图片列表
desc
查询热门图片
uri
/oapi/backend/column/image/list
请求方式
GET
参数
# 普通参数
columnId:hot // [固定][字母] 热门栏目
type:xxx // [非空][字符串] 图片类型
## type说明
1. 动图压缩：将返回的动图压缩到2M、1M、500K内 type=S_2M[可选：1M、500K]
2. 动图缩放：将返回动图按宽度缩放 type=Z_200x100[可任意调整数值]
3. 动图裁剪：按指定大小缩放后裁剪动图中心位置内容type=C_200x100[可任意调整数值]
# 分页参数
pageNumber:xxx // [非空][数字] 页码
pageSize:xxx // [非空][数字] 每页条数
# 验证参数
timestamp:xxx // [非空][数字] 当前系统13位时间戳
scope:xxx // [非空][字符串] 代表公司
sign:xxx // [非空][字符串] 接口签名 md5(columnId+scope+timestamp+SALT)拼接时不需要中间“+”符号
返回格式(json)
成功返回
{
code:200,
msg:success,
data:{
pagination:{
pageNumber:xxx, // 页码
pageSize:xxx, // 每页条数
pageCount:xxx, // 总页数
allCount:xxx // 总条数
cover:xx // 栏目封面
updatetime:xx // 最后更新时间
},
images:[
{
serialCode:xxx, // 序列号
title:xxx, // 标题
url:xxx, // 图片URL
fixedurl:xxx // 减帧图片URL
mp4Url:xxx // mp4格式Url
webpUrl:xxx // webp格式Url
size:xxx, // 原图大小
md5:xxx, // 图片MD5
height:xxx, // 原图高度
width:xxx // 原图宽度
},{},{} ...
]
}
}
错误返回
{code:920,msg:"auth"} // sign出错
{code:900,msg:"xxx"} // 系统异常，详细信息请查看msg
说明
其他错误码说明参考文档
示例
api.soogif.com/oapi/backend/column/image/list?scope=test&columnId=hot×tamp=1478749249000&sign=97106164f01f57473e78dbd2148ac729
6. 查询热门搜索词接口
desc
查询当前热门搜索词列表，返回前20个热门搜索词
uri
/oapi/backend/tag/hotwords
请求方式
GET
参数
# 验证参数
timestamp:xxx // [非空][数字] 当前系统13位时间戳
scope:xxx // [非空][字符串] 代表公司
sign:xxx // [非空][字符串] 接口签名 md5(scope+timestamp+SALT)拼接时不需要中间“+”符号
返回格式(json)
成功返回
{
code:200,
msg:success,
allCount:xxx // 返回条数
tags:[
"xxx", // 词1
"xxx", // 词2
"xxx", // 词3
"xxx", // 词4
...
]
}
错误返回
{code:920,msg:"auth"} // sign出错
{code:900,msg:"xxx"} // 系统异常，详细信息请查看msg
说明
其他错误码说明参考文档
示例
api.soogif.com/oapi/backend/tag/hotwords?scope=test×tamp=1478749249000&sign=97106164f01f57473e78dbd2148ac729