[关闭]
@sewise-dev 2016-08-24T01:53:12.000000Z 字数 4164 阅读 687

香港卫视APP接口剖析 - 设置

香港卫视


一、设置(未登录)

1.用户信息

请求地址:mod=App&do=
传参:无
返回值:json格式,
        用户头像    user_avatar
        用户昵称    user_nickname

2.最近浏览

请求地址:
传参:用户标识           user_id
返回值:json格式,
        用户唯一标识    user_id
        新闻标题        news_title
        新闻id          news_id
        浏览时间        browsing_time(按照指定时间格式)

3.关于我们

请求地址:  mod=App&do=AboutUs
传参:无
返回值:json格式,
        图片地址        img
        版本号          version
        官方微信        weixin
        联系邮箱        email

返回值示例

  1. {
  2. "success": true,
  3. "data": {
  4. "img": "http://hktv.io/userdata/logo/logo.jpg",
  5. "version": "3.3",
  6. "weixin": "港视速睇",
  7. "email": "HKS@hkstv.tv"
  8. }
  9. }

4.我的视频

a.用户视频列表
请求地址:mod=App&do=UserVido
传参:  用户标识        user_id
        页码            page(可择参数,不穿默认为1)
返回值:json格式,
        是否成功        success(bool值true)
        文件信息        data包含以下字段
                        用户标识    user_id
                        文件标识    sourceid
                        文件状态    file_status
                        文件名      video_name
                        创建时间    create_time
                        截图        img
                        视频地址    video_url
b.删除视频(包含批量删除)
    请求地址:mod=App&do=UserVideoEdit
    传参: 用户唯一标识     user_id
           操作标识         op(固定字符串op='delete')
           要删除的视频标识 video_id(批量操作时为多个video_id的集合)
    返回值:json格式,
            是否操作成功    success(bool值true,false)
            错误信息        error_info(success=true时为null,success=false时为错误信息)
c.视频重命名
    请求地址:mod=App&do=UserVideoEdit
    传参: 用户唯一标识     user_id
           操作标识         op(固定字符串op='rename')
           要删除的视频标识 video_id
    返回值:json格式,
            是否操作成功    success(bool值true,false)
            错误信息        error_info(success=true时为null,success=false时为错误信息)

5.登录

a.用香港卫视帐号登录
    请求地址:mod=App&do=Login
    传参:  是否第三方帐号  is_third_party(值为0)
            用户帐号        user_name
            用户密码        user_pass
    返回值:json格式,
            登录成功
                            是否成功    success(bool值true)
                            用户信息    user_info
                                        用户昵称    user_nickname
                                        用户头像    user_avatar
                                        用户标识    user_id
                                        用户性别    user_gender
            登录失败
                            是否成功    success(bool值false)
                            错误信息    error_info(可能的错误原因)

示例1

  1. {
  2. "success": true,
  3. "user_info": {
  4. "user_id": "37",
  5. "user_nickname": "哈哈哈",
  6. "user_avatar": "http://hktv.io/userdata/avatar/1604/06/M2YqC7mg.png",
  7. "user_state": "1",
  8. "user_gender": "F"
  9. },
  10. "upload": {
  11. "upload_url": "http://192.168.1.23:8888/api/file/fupload",
  12. "capture_image": true,
  13. "upload_callback": "http://192.168.1.107/?mod=App&do=SaveVideoInfo",
  14. "tag": "37"
  15. }
  16. }

示例2

  1. {
  2. "success": false,
  3. "error_info": "用户不存在"
  4. }
b.用第三方帐号登录
    请求地址:
    传参:  是否第三方帐号  is_third_party(值为1)
            第三方平台用户唯一标识     user_id
            第三方平台用户昵称         user_nickname
            第三方平台用户头像         user_avatar
    返回值:json格式,
            登录成功
                        是否成功    success(bool值true)
                        用户信息    user_info
                                    用户昵称    user_nickname
                                    用户头像    user_avatar
                                    用户标识    user_id(此处为香港卫视用户标识)
                        示例:
                {"success":true,"user_info":{"user_nickname":"x","user_avatar":"x","user_id":"x"}}
            登录失败
                        是否成功    success(bool值false)
                        错误信息    error_info(可能的错误原因)
                        示例:
                {"success":false,"error_info":"xxx"}

6.注册

请求地址:mod=App&do=Register
传参:  手机号          phone_number
        验证码          verify_code
        密码            user_pass
        昵称            user_nickname
        token值         token(服务器生成的token)
        国家和地区代码  country_code
返回值:json格式,
        注册成功
                        是否成功    success(bool值true)
                        用户信息    user_info
                                        用户标识    user_id(此处为香港卫视的用户唯一标识)
                        示例:
                {"success":true,"user_info":{"user_id":"x"}}
        注册失败
                        是否成功    success(bool值false)
                        错误信息    error_info(可能的错误原因)
                        示例:
                        {"success":false,"user_info":"xxx"}

7.获取短信验证码

请求地址:mod=App&do=MessageVerify
传参:  手机号          phone_number
        国家和地区代码  country_code
返回值:json格式,
        是否成功        success
        token值         token

示例1

  1. {"success":true,"token":"65bd870462e56f6fa3de58f9cfc27852"}

示例2

  1. {"success":false,"error_info":"手机号不正确,请重新输入"}

8.判断用户是否为白名单用户

请求地址:mod=App&do=CheckUserState
传参:  用户id          user_id
返回值:json格式,
        是否白名单      success(布尔值)
        白名单用户上传需要的参数
        上传地址        upload_url
        开启截图        capture_image(固定值布尔值true)
        回调地址        upload_callback
        标识            tag(此参数值即为用户的id)

示例1

  1. {
  2. "success": false,
  3. "error_info": "非白名单用户"
  4. }

示例2

  1. {
  2. "success": true,
  3. "data": {
  4. "upload_url": "http://192.168.1.23:8888/api/file/fupload",
  5. "capture_image": true,
  6. "upload_callback": "http://192.168.1.107/?mod=App&do=SaveVideoInfo",
  7. "tag": "19"
  8. }
  9. }

二、已登陆用户更改个人信息

1.设置头像、昵称、性别共用本接口(传参不同)

请求地址:mod=App&do=EditUserInfo

1).设置头像

传参:  操作类型        op='change_avatar'(op为固定字符串)
        用户标识        user_id
        表单的name值    固定字符串'avatar'
返回值:json格式,
        是否成功        success(bool值true)
        用户信息        user_info包含以下字段
                        用户标识    user_id
                        用户头像    user_avatar

2).设置昵称

传参:  操作类型        op='change_nickname'(op为固定字符串)
        用户标识        user_id
        用户昵称        user_nickname
返回值:json格式,
        是否成功        success(bool值true)
        用户信息        user_info包含以下字段
                        用户标识    user_id
                        用户昵称    user_nickname

3).设置性别

传参:  操作类型        op='change_gender'(op为固定字符串)
        用户标识        user_id
        用户性别        user_gender(值只能为字符串'M'(标识男性)或者'F'(标识女性))
返回值:json格式,
        是否成功        success(bool值true)
        用户信息        user_info包含以下字段
                        用户标识    user_id
                        用户性别    user_gender

三、用户视频

1.用户视频列表

请求地址:mod=App&do=UserVido
传参:  用户标识        user_id
        页码            page(可择参数,不穿默认为1)
返回值:json格式,
        是否成功        success(bool值true)
        文件信息        data包含以下字段
                        用户标识    user_id
                        文件标识    sourceid
                        文件状态    file_status
                        文件名      video_name
                        创建时间    create_time
                        截图        img
                        视频地址    video_url

2.用户编辑视频(删除、重命名)

###删除###
请求地址:mod=App&do=UserVideoEdit
传参: 用户唯一标识     user_id
        操作标识         op(固定字符串op='delete')
        要删除的视频标识 video_id(批量操作时为多个video_id的集合)
返回值:json格式,
        是否操作成功    success(bool值true,false)
        错误信息 error_info(success=true时为null,success=false时为错误信息)


###重命名####
请求地址:mod=App&do=UserVideoEdit
传参: 用户唯一标识     user_id
        操作标识         op(固定字符串op='rename')
        要重命名的视频标识 video_id
        重命名为        video_name
返回值:json格式,
        是否操作成功    success(bool值true,false)
        错误信息        error_info(success=true时为null,success=false时为错误信息)    
添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注