表情搜搜API 说明文档

表情搜搜API是一个全网动图、表情图片搜索引擎。

API列表

一、接口统一说明

1. 接口服务器地址

http://open-api.biaoqingmm.com/open-api

https://open-api.biaoqingmm.com/open-api

2. 业务接口统一参数

调用表情搜搜API时必须提供的request参数。

key required desc
timestamp required 请求时间戳(长度为13位),单位:毫秒(unix时间戳,open api只接收五分钟内的请求)
ssl_res optional ssl_res=true时,返回https资源
app_id required 接入应用id
signature required 接口签名密钥
partner optional 合作伙伴名称

3. 错误编码

  • 10001 参数错误
  • 40001 签名密钥不匹配,或时间戳过期
  • 500 服务器内部错误

4. 签名认证

为了确保每次接口请求的真实有效性,我们对每一个 api访问请求都需要做签名认证。

签名算法为:

Signature = MD5(Request_URI + 按字典顺序升序排列的 Query(String).toUpperCase()

假设有接口为

http://open-api.biaoqingmm.com/open-api/emojis/net/search?q=hi&timestamp=1479696005651&app_id=YOUR_APP_ID

则:

Signature = MD5("http://open-api.biaoqingmm.com/open-api/emojis/net/search" + "app_id=YOUR_APP_ID&q=hi&timestamp=1479696005651").toUpperCase()

如果使用https请求,请将带https的url加入计算,算法不变:

Signature = MD5("https://open-api.biaoqingmm.com/open-api/emojis/net/search" + "app_id=YOUR_APP_ID&q=hi&ssl_res=true&timestamp=1479696005651").toUpperCase()

因此,实际应该请求的接口为:

http://open-api.biaoqingmm.com/open-api/emojis/net/search?app_id=YOUR_APP_ID&q=hi&timestamp=1479696005651&signature=7A44A88202EAF9AF0A40A8AF843E229E

或(SSL):

https://open-api.biaoqingmm.com/open-api/emojis/net/search?q=hi&ssl_res=true&p=&size=&app_id=YOUR_APP_ID&timestamp=1479696005651&signature=EAC3E86DF1EF5E3521DAF08EF631208B

注一:请在 app_id=YOUR_APP_ID 中,填入您从表情云处得到的 app_id。

如果API返回“error_code: 40001“签名错误,可以按照以下步骤进行简单的排查:

  1. “http”或“https”需要加入md5计算
  2. URL中的“?”不加入md5计算
  3. timestamp使用13位时间戳
  4. 中文参数q在md5前不需要encode
  5. 所有参数在计算md5前,需要按照字典升序排序
  6. URL里的signature需要转为大写

二、申请app_id

表情搜搜API用户需先申请app_id,申请成功后可使用完整服务。

请发送申请邮件至 cheng.li@siyanhui.com ,并简单描述您的产品使用场景和接入需求,我们会有工作人员与您联系。

三、表情搜搜 API

动图搜索包括网络最全的GIF内容,不仅拥有全网最全GIF内容,还包括了大量独家IP授权的GIF动图

Path

/gifs/search

Param

name type required desc
q string required 搜索关键字,可直接搜索一个词或短句
p int optional 分页页码,从1开始
size int optional 页面大小,默认为20
fs enum optional 图片尺寸限制,取值见fs参数说明;默认返回原始图片
fs_limit int optional 返回主图文件最大值,单位为KB,fs_limit=1024表示只返回小于1M的图片
gt_min int optional 设置gif_thumb图片最短边,单位为px
gt_max int optional 设置gif_thumb图片最长边,默认最长边为200px
gt_crop string optional 缩略图剪裁尺寸,格式width+x+height,例gt_crop=100x100会返回100x100px的缩略图;如果缩略图本身小于指定尺寸,不会剪裁;如果设置了gt_min或gt_max,会将图片缩放后进行剪裁。

Response

{
  "gifs": [
  {
    "thumb": "http://7xl6jm.com2.z0.glb.qiniucdn.com/netpic/20160925220542ZCOESPS3N5GQNPJG.gif?imageMogr2/thumbnail/!80p/format/png", 
    //缩略图,默认为主图尺寸的80%
    "gif_thumb": "http://7xl6jm.com2.z0.glb.qiniucdn.com/netpic/20160901225125635QJA6EQG07YAMK_th4.gif", 
    //动态缩略图,动态表情均会提供,大小为40KB左右,能大大节省客户端流量
    "main": "http://7xl6jm.com2.z0.glb.qiniucdn.com/netpic/20160925220542ZCOESPS3N5GQNPJG.gif", 
    //表情主图,可能是gif, png或jpg格式
    "width": 165,  //返回图片宽度,单位px
    "height": 110, //返回图片高度,单位px
    "fsize": 917576, //文件大小,单位是B
  },
  ...
  ],
  "count": 30, //搜索结果总数
  "error_code":0 //错误码,0表示正确
}

表情搜搜包括所有网络表情,不仅有动图,也包括静态图片

Path

/emojis/net/search

Param

name type required desc
q string required 搜索关键字,可直接搜索一个词或短句
p int optional 分页页码,从1开始
size int optional 页面大小,默认为20
fs enum optional 图片尺寸限制,取值见fs参数说明;默认返回原始图片
fs_limit int optional 返回主图文件最大值,单位为KB,fs_limit=1024表示只返回小于1M的图片
gt_min int optional 设置gif_thumb图片最短边,单位为px
gt_max int optional 设置gif_thumb图片最长边,默认最长边为200px
gt_crop string optional 缩略图剪裁尺寸,格式width+x+height,例gt_crop=100x100会返回100x100px的缩略图;如果缩略图本身小于指定尺寸,不会剪裁;如果设置了gt_min或gt_max,会将图片缩放后进行剪裁。

Response

{
  "emojis": [
  {
    "text": "你好", //表情参考文案
    "thumb": "http://7xl6jm.com2.z0.glb.qiniucdn.com/netpic/20160925220542ZCOESPS3N5GQNPJG.gif?imageMogr2/thumbnail/!80p/format/png", 
    //缩略图,默认为主图尺寸的80%
    "gif_thumb": "http://7xl6jm.com2.z0.glb.qiniucdn.com/netpic/20160901225125635QJA6EQG07YAMK_th4.gif", 
    //动态缩略图,动态表情均会提供,大小为40KB左右,能大大节省客户端流量
    "main": "http://7xl6jm.com2.z0.glb.qiniucdn.com/netpic/20160925220542ZCOESPS3N5GQNPJG.gif", 
    //表情主图,可能是gif, png或jpg格式
    "width": 165,  //返回图片宽度,单位px
    "height": 110, //返回图片高度,单位px
    "fsize": 917576, //文件大小,单位是B
    "is_animated": "1"  //是否动态(gif)表情,1为动态表情,0为静态表情
  },
  ...
  ],
  "count": 30, //搜索结果总数
  "error_code":0 //错误码,0表示正确
}

授权表情包括表情云原创和授权IP的表情包内容,此部分内容只开放给高级合作伙伴,请先联系我司商务人员 Path

/stickers/search

Param

name type required desc
q string required 搜索关键字,不可分词或搜索多个关键字
p int optional 分页页码,从1开始
size int optional 页面大小,默认为20

Response

{
  "stickers": [
  {
    "text": "你好", //表情参考文案
    "thumb": "http://7xl6jm.com2.z0.glb.qiniucdn.com/netpic/20160925220542ZCOESPS3N5GQNPJG.gif?imageMogr2/thumbnail/!80p/format/png", //缩略图,默认为主图尺寸的80%
    "main": "http://7xl6jm.com2.z0.glb.qiniucdn.com/netpic/20160925220542ZCOESPS3N5GQNPJG.gif", //表情主图,可能是gif, png或jpg格式
    "width": 240,  //返回图片宽度,单位px
    "height": 240, //返回图片高度,单位px
    "fsize": 917576, //文件大小,单位是B
    "is_animated": "1"  //是否动态(gif)表情,1为动态表情,0为静态表情
  },
  ...
  ],
  "count": 30, //搜索结果总数
  "error_code":0 //错误码,0表示正确
}

获取最近网络流行动图列表

Path

/trending

Param

name type required desc
p int optional 分页页码,从1开始
size int optional 页面大小,默认为20

Response

{
  "emojis": [
    {
      "text": "bye", //表情含义词
      "thumb": "http://7xl6jm.com2.z0.glb.qiniucdn.com/@/emoticonPacket/51eb87ba6c8f4113b674a0732f40d8d7/thumicon/1466066986063_01.png", //表情缩略图,尺寸为120x120px,png
      "main": "http://7xl6jm.com2.z0.glb.qiniucdn.com/@/emoticonPacket/51eb87ba6c8f4113b674a0732f40d8d7/mainicon/1466066980760_01.gif",//表情主图,尺寸为240x204px,gif
      "width": 240, //表情主图宽度,单位px
      "height": 240, //表情主图高度,单位px
      "copyright": "Mojif", //表情版权信息
      "is_animated": "0" //是否动态表情,1为动态,0为静态
    },
    ...
  ],
  "count": 386,//搜索结果总数
  "error_code": 0//错误码,0表示正确
}

5. 热门搜索标签 - Hot Tags

获取最近热门关键词列表

Path

/netword/hot

Param

Response

{    
    "error_code":0,
    "data_list":[
      {
        "text":"红包",
        "width": 180, //封面图宽度
        "height": 180, //封面图高度
        "fs": 10569, ////封面图图片文件大小 
        "cover":"https://dn-bqmm.qbox.me/netpic/201611012109235YSLHUELA8I38L3G.jpeg" //封面图片
      },
      {
        "text":"斗图",
        "width": 180,
        "height": 180,
        "fs": 10569,
        "cover":"https://dn-bqmm.qbox.me/netpic/20160901162140MA2BKY4MK687VKEU.jpeg"
      },
      {
        "text":"老司机",
        "width": 180,
        "height": 180,
        "fs": 10569,
        "cover":"https://dn-bqmm.qbox.me/netpic/201611012114300APQ3NERA2W1BDEV.jpeg"
      },
      {
        "text":"黄子韬",
        "width": 180,
        "height": 180,
        "fs": 10569,
        "cover":"https://dn-bqmm.qbox.me/netpic/20160901214806CK1ZAYKKQ8UY2M4M.gif"
      }
    ]
}

四、补充说明

fs参数说明

value desc
large 最短边固定为320px,如果图片最短边小于320px,则返回原图
medium 最短边固定为240px,如果图片最短边小于240px,则返回原图,推荐客户端选用此尺寸
small 最短边固定为80px,如果图片最短边小于80px,则返回原图

从节省客户端流量的角度考虑,推荐在表情列表页面优先使用返回的动态缩略图(gif_thumb)

results matching ""

    No results matching ""