bluedazzle / dionysus-backend

Dionysus Backend

大头秀接口文档

标签（空格分隔）： api

---

Datoushow API

---

host: http://datoushow.com

api_version: v1

#概要

2. API请求格式：host + "api" + api_version + 请求地址。（eg: http://datoushow.com/api/v1/videos）
3. API返回格式：json:{"status":1,"body":{}}status返回操作结果码,body包含返回信息，如果无返回信息，body为空。
4. status结果码对照表：

status结果码	状态
0	未知错误
1	成功
2	权限不足
3	帐号不存在
4	数据错误
5	密码错误
6	已存在
7	不存在
8	已过期
10	验证码为空
11	验证码错误

#API安全

为保证接口调用安全，所有接口都需要：timestamp与sign两个参数，用来验证接口请求的合法性。其中：

1. timestamp是类型为数字的10位的时间戳，代表发生请求时的时间。
2. sign 是类型为字符串的32位验证字符串，具体生成方式为MD5(timestamp + secret)，其中secret 从系统申请后分配。请保证secret 的安全性，如果不慎泄露请及时更换。
3. 验证合法性请均使用参数拼接方式构造参数请求，即在所有请求地址后构造类似?timestamp=xx&sign=xx的参数

#文档

#视频 ##获取视频列表

GET /videos

###Parameters

• type(Required|integer)-视频类别
• like(Optional|integer)-是否获取最热视频
• search(-Optional_|string)-搜索内容
• page(Optional|integer)-分页

type码	状态
1	电影
2	mv
3	搞笑
4	综艺
5	新年

###Return 成功

{
  "body": {
    "page_obj": {},
    "is_paginated": false,
    "video_list": [
      {
        "classification": 1,
        "thumb_nail": "http://oda176fz0.bkt.clouddn.com/WeChatSight2.mp4?vframe/jpg/offset/1/w/200/h/200/",
        "reference": "dd",
        "title": "WeChatSight2",
        "url": "http://oda176fz0.bkt.clouddn.com/WeChatSight2.mp4",
        "author": "pp",
        "create_time": "2016-09-12 15:31:52",
        "modify_time": "2016-09-12 15:31:52",
        "id": 1,
        "like": 0
      },
      {
        "classification": 1,
        "thumb_nail": "http://oda176fz0.bkt.clouddn.com/别担心，我罩着你呢.avi?vframe/jpg/offset/1/w/200/h/200/",
        "reference": "女间谍",
        "title": "别担心，我罩着你呢",
        "url": "http://oda176fz0.bkt.clouddn.com/别担心，我罩着你呢.avi",
        "author": "皮皮",
        "create_time": "2016-09-12 15:44:27",
        "modify_time": "2016-09-12 15:44:27",
        "id": 2,
        "like": 0
      }
    ]
  },
  "status": 1,
  "msg": "success"
}

失败

{
  "body": {},
  "status": 4,
  "msg": "数据缺失"
}

##获取视频详细信息

GET /video/<id>

###Return 成功

{
  "body": {
    "video": {
      "classification": 3,
      "thumb_nail": "http://static.fibar.cn/nishihouzi_0.mp4?vframe/jpg/offset/0/w/200/h/200/",
      "reference": "",
      "author": "红孩儿",
      "url": "http://static.fibar.cn/nishihouzi_0.mp4",
      "weibo_title": "变身热门短视频中的主角，释放你的洪荒之力，快来一起玩吧~",
      "title": "你是猴子请来的救兵吗",
      "tag": "",
      "wechat_sub_title": "变身热门短视频中的主角，释放你的洪荒之力，快来一起玩吧~",
      "order": 9,
      "tracks": [
        {
          "frame": 1,
          "time": 0,
          "y": 100,
          "x": 237,
          "rotation": 0,
          "size": 0
        },
        ...
        {
          "frame": 177,
          "time": 7.08,
          "y": 19,
          "x": 114,
          "rotation": 0,
          "size": 328
        }
      ],
      "subtitle": [
        {
          "content": "Only 3 of the water on our planet is fresh.",
          "index": 1,
          "start_time": "0:00:33.843000",
          "end_time": "0:00:38.097000"
        },
        {
          "content": "Yet, these previous waters are rich with surprise.",
          "index": 2,
          "start_time": "0:00:40.641000",
          "end_time": "0:00:44.687000"
        },
        {
          "content": "All life on land is ultimately dependent on fresh water.",
          "index": 3,
          "start_time": "0:00:57.908000",
          "end_time": "0:01:03.414000"
        }
      ],
      "has_subtitle": true,
      "create_time": "2016-11-01 11:52:18",
      "fps": 25,
      "duration": 7.08,
      "hidden": true,
      "total_frames": 177,
      "wechat_title": "",
      "id": 135,
      "like": 7
    }
  },
  "status": 1,
  "msg": "success"
}

失败

{
  "body": {},
  "status": 4,
  "msg": "数据缺失"
}

##分享视频

POST /share

###Parameters

• url(Required|string)-视频链接
• uid(Required|string)-用户识别码
• vid(Required|string)-被变脸视频id
• token(Required|string)-视频唯一的token

###Return 成功

{
  "body": {"url": "xxxx",
           "thumb_nail": "xxxx",
           "weibo_title": "xxxx",
           "wechat_title": "xxxx",
           "wechat_sub_title": "xxxx"},
  "status": 1,
  "msg": "success"
}

失败

{
  "body": {},
  "status": 4,
  "msg": "数据缺失"
}

##获取七牛上传token

get /upload

###Return 成功

{
  "body": {"token": "xxx"},
  "status": 1,
  "msg": "success"
}

失败

{
  "body": {},
  "status": 4,
  "msg": "数据缺失"
}

##获取banner信息

get /banners

###Return

返回值 nav 含义：

nav 码	含义
0	跳转到拜年分类
1	跳转到分享给好友

成功

{
  "body": {
    "banner_list": [
      {
        "picture": "sss",
        "remark": "sss",
        "create_time": "2017-01-18 10:45:43",
        "nav": 0,
        "modify_time": "2017-01-18 10:45:43",
        "active": true,
        "id": 1
      }
    ],
    "page_obj": {},
    "is_paginated": false
  },
  "status": 1,
  "msg": "success"
}

失败

{
  "body": {},
  "status": 4,
  "msg": "数据缺失"
}

##获取分类信息

get /classifications

###Return

type码	状态
1	电影
2	mv
3	搞笑
4	综艺
5	新年

成功

{
  "body": {
    "classification_list": [
      {
        "select_icon": "http://static.fibar.cn/bannerz.png",
        "type": 1,
        "name": "搞笑",
        "icon": "http://static.fibar.cn/bannerz.png"
      }
    ],
    "page_obj": {},
    "is_paginated": false
  },
  "status": 1,
  "msg": "success"
}

失败

{
  "body": {},
  "status": 4,
  "msg": "数据缺失"
}