Demo - v20161028

SOOGIF OPEN API 文档 v1.0.3 Beta

SOOGIF API 概述

SOOGIF 是国内首家gif动图搜索引擎网站,应用开发者可以使用SOOGIF API 接口功能,丰富自身应用图库,快速开发动图场景功能

更新说明

V1.03版本:提供减帧图片fixedUrl,选取关键帧新建gif图片,调用可以大大减少缩略显示时的体积和加载速度,内存占用变得更少,使用更流畅

分类动图接口

SOOGIF拥有专业的编辑团队打造官方分类,实时更新热点事件和表情开发者可以直接使用 SOOGIF 官方内容分类,也可以根据自身需求调用内容分类

搜索接口

搜索接口可以通过文字匹配调用动图搜索,开发者可根据自身应用场景,自由调用库中动图

动图处理

API内根据不同场景,对尺寸、大小做了相应优化,通关简单的参数调整可根据需求自由调用、缩放、裁剪适合动图

接入步骤与说明

1. 开发者在线申请

    请在首页申请入口填写相应申请需求,我们会第一时间联系你

2. 获取应用ID

    通过申请之后,我们会为内测产品提供唯一的应用ID,根据规则加密后在调用接口中填写使用,请保管好调用ID不要泄露

3. 开始使用

    根据接口调用指南接入使用SOOGIF API 内容

4. 接入声明

    接入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帧,可用作缩略图
                size:xxx        // 原图大小
            },{},{} ...
        ]
    }
}

错误返回
{code:920,msg:"auth"}  // sign出错       
{code:900,msg:"error"} // 系统异常     

说明

其他错误码说明参考文档

示例

/oapi/backend/image/search?text=%E6%90%9E%E7%AC%91&&type=S_2M&scope=test&timestamp=1478749249000&sign=7F1DE2XE6DA19D22B51C68001E7E0E54

2. 查询栏目

desc

查询栏目列表

uri

/oapi/backend/column/list

请求方式

GET

参数

# 普通参数
无

# 分页参数
pageNumber:xxx // [非空][数字,固定值:1] 第一页
pageSize:xxx   // [非空][数字,默认:30] 每页条数

# 验证参数
timestamp:xxx // [非空][数字] 当前系统13位时间戳
scope:xxx     // [非空][字符串] 代表公司
sign:xxx      // [非空][字符串] 接口签名 md5(scope+timestamp+SALT)拼接时不需要中间“+”符号

返回格式(json)

成功返回
{
    code:200,
    msg:success,
    data:{
        columns:[
            {
                id:xx,        // 栏目ID
                title:xx      // 标题
            },{},{},{} ...
        ]
    }
}

错误返回
{code:920,msg:"auth"}  // sign出错       
{code:900,msg:"error"} // 系统异常 

说明

其他错误码说明参考文档 

示例

/oapi/backend/column/list?scope=test&timestamp=1478749249000&sign=7F1DE2XE6DA19D22B51C68001E7E0E54   

3. 查询图片列表

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:0,
    msg:success,
    data:{
        pagination:{
            pageNumber:xxx, // 页码
            pageSize:xxx,   // 每页条数
            pageCount:xxx,  // 总页数
            allCount:xxx    // 总条数
        },
        images:[
            {
                serialCode:xxx, // 序列号
                title:xxx,      // 标题
                url:xxx,        // 图片URL
                size:xxx,       // 原图大小
                md5:xxx         // 图片MD5
            },{},{} ...
        ]
    }
}

错误返回
{code:920,msg:"auth"}  // sign出错       
{code:900,msg:"error"} // 系统异常    

说明

其他错误码说明参考文档 

示例

/oapi/backend/column/image/list?scope=test&columnId=15&timestamp=1478749249000&sign=7F1DE2XE6DA19D22B51C68001E7E0E54