X直播新版API文檔

X直播 App API 接口

接口修改說(shuō)明

日期 修改人
2015/11/30 王小柱

目錄

[TOC]

接口文檔概要說(shuō)明

  • 文檔是《X直播平臺(tái)接口通訊協(xié)議》的補(bǔ)充版本， 旨在快速定義相關(guān)接口
  • 系統(tǒng)接口使用http作為承載協(xié)議，使用HTTP GET 請(qǐng)求；傳遞參數(shù)為URL UTF-8編碼，返回結(jié)果為UTF-8編碼
  • 加密Sig為32位MD5數(shù)字簽名大寫(xiě)字符串
  • 接口加密方式照舊
  • 接口返回參數(shù)為json格式
  • 接口地址由接口url與調(diào)用method確定唯一性
  • 所有接口請(qǐng)求頭中將加入?yún)?shù)Channel: 渠道 version: 版本號(hào) Device-Id: 設(shè)備號(hào) platform: 平臺(tái) android/ios user: 用戶id 可能會(huì)為空
  • 所有接口傳入的默認(rèn)參數(shù)為
    • method 方法名
    • name 調(diào)用用戶
    • password 調(diào)用密碼
    • meid 設(shè)備號(hào)
    • timestamp 時(shí)間戳
    • sig 加密串
  • 所有接口參數(shù)拼接加密后 使用http:\\xxxx:port/com/xxx.action?paramStr=加密串方式請(qǐng)求服務(wù)器

API LIST

1、首頁(yè)推介接口

| url | method |
| ----------|-------------------------------:|
| http://ip:port/interface/user/xxx.action | method|
首頁(yè)接口，包括首頁(yè)推薦列表和直播條信息

請(qǐng)求參數(shù)

  • user_id: 用戶id

返回參數(shù)

  • errorcode 00 成功
  • msg 服務(wù)器提示信息
  • recData: 首頁(yè)推薦信息（直播條）,列表
    • id
    • type: 類型 0: 視頻 1: 音頻 2: 文章 3: 專題
    • tag: 標(biāo)簽，界面顯示的紅色文字標(biāo)簽
    • title: 標(biāo)題
    • desc: 描述
  • vidData 視頻信息，列表
    • title: 標(biāo)題
    • id: 可以根據(jù)id獲取對(duì)應(yīng)的列表
    • vids 視頻列表
      • id
      • channelType: 類型 0: 視頻 1: 音頻 2: 文章 3: 專題
      • img: 預(yù)覽圖
      • title: 標(biāo)題
      • view: 點(diǎn)擊量
      • comments 評(píng)論數(shù)
{
    "errorcode": 0,
    "msg": "提示",
    "recData": [
        {
            "id": 1231231232,
            "type": 3,
            "tag": "直播",
            "desc": "描述",
            "title": "標(biāo)題"
        },
        {
            "id": 1231231232,
            "type": 3,
            "tag": "直播",
            "desc": "描述",
            "title": "標(biāo)題"
        }
    ],
    "vidData": [
        {
            "title": "附近人都在看",
            "id": "列表id",
            "vids": [
                {
                    "id": 23142341,
                    "title": "真娘子",
                    "channelType": 2,
                    "img": "http:\\sssss.jpg",
                    "url": "播放地址",
                    "view": "12421 播放次數(shù)",
                    "comments": "1234評(píng)論次數(shù)"
                },
                {
                    "id": 23142341,
                    "title": "真娘子",
                    "channelType": 2,
                    "img": "http:\\sssss.jpg",
                    "url": "播放地址",
                    "view": "12421 播放次數(shù)",
                    "comments": "1234評(píng)論次數(shù)"
                }
            ]
        },
        {
            "title": "最近熱播",
            "id": "列表id",
            "vids": [
                {
                    "id": 23142341,
                    "title": "真娘子",
                    "channelType": 2,
                    "img": "http:\\sssss.jpg",
                    "url": "播放地址",
                    "view": "12421 播放次數(shù)",
                    "comments": "1234評(píng)論次數(shù)"
                },
                {
                    "id": 23142341,
                    "title": "真娘子",
                    "channelType": 2,
                    "img": "http:\\sssss.jpg",
                    "url": "播放地址",
                    "view": "12421 播放次數(shù)",
                    "comments": "1234評(píng)論次數(shù)"
                }
            ]
        }
    ]
}

2、首頁(yè)電視接口

| url | method |
| ----------|-------------------------------:|
| http://ip:port/interface/user/xxx.action | method|
首頁(yè)的電視列表頁(yè)

請(qǐng)求參數(shù)

無(wú)

返回參數(shù)

  • errorcode 00 成功
  • msg
  • data 分類列表
    • id
    • programImg 當(dāng)前節(jié)目圖片
    • title 電視臺(tái)名稱
    • program 當(dāng)前節(jié)目
    • timeTag 時(shí)間安排， 如 直播時(shí)間 10:26-20:00 或者每周五 10:26-20:00
    • fan 當(dāng)前觀看人數(shù)
{
    "errorcode": 0,
    "msg": "提示",
    "data": [
        {
            "id": "dafdasdf",
            "programImg": "xxx.jsg",
            "title": "CCTV5",
            "program": "動(dòng)物世界",
            "timeTag": "直播時(shí)間 10:26-20:00",
            "fan": 342451
        },
        {
            "id": "dafdasdf",
            "programImg": "xxx.jsg",
            "title": "CCTV8",
            "program": "金瓶梅",
            "timeTag": "直播時(shí)間 18:26-22:00",
            "fan": 324511
        }
    ]
}

3、首頁(yè)電臺(tái)接口

| url | method |
| ----------|-------------------------------:|
| http://ip:port/interface/user/xxx.action | method|
首頁(yè)的電臺(tái)的列表接口，需要 返回歷史收聽(tīng)記錄和所有的電臺(tái)

請(qǐng)求參數(shù)

無(wú)

返回參數(shù)

  • errorcode 00 成功
  • msg
  • data 分類列表
    • id
    • programImg 當(dāng)前節(jié)目圖片
    • title 電視臺(tái)名稱
    • program 當(dāng)前節(jié)目
    • timeTag 時(shí)間安排， 如 直播時(shí)間 10:26-20:00 或者每周五 10:26-20:00
    • fan 當(dāng)前觀看人數(shù)
  • hotData 熱門電臺(tái)
    • id
    • title 電臺(tái)名稱
    • img電臺(tái)圖片
    • fan 當(dāng)前觀看人數(shù)
  • historyData 最近收聽(tīng)
    • id
    • title 電臺(tái)名稱
    • logo電臺(tái)小圖logo
    • fan 當(dāng)前觀看人數(shù)
{
    "errorcode": 0,
    "msg": "提示",
    "data": [
        {
            "id": "dafdasdf",
            "programImg": "xxx.jsg",
            "title": "fn 987",
            "program": "動(dòng)物世界",
            "timeTag": "直播時(shí)間 10:26-20:00",
            "fan": 342451
        },
        {
            "id": "dafdasdf",
            "programImg": "xxx.jsg",
            "title": "FM 451",
            "program": "金瓶梅",
            "timeTag": "直播時(shí)間 18:26-22:00",
            "fan": 324511
        }
    ],
    "hotData": [
        {
            "id": "dafdasdf",
            "img": "xxx.jsg",
            "title": "FM 451",
            "fan": 324511
        },
        {
            "id": "dafdasdf",
            "img": "xxx.jsg",
            "title": "FM 451",
            "fan": 324511
        }
    ],
    "historyData": [
        {
            "id": "dafdasdf",
            "logo": "xxx.jsg",
            "title": "FM 451",
            "fan": 324511
        },
        {
            "id": "dafdasdf",
            "logo": "xxx.jsg",
            "title": "FM 451",
            "fan": 324511
        }
    ]
}

4、首頁(yè)活動(dòng)接口

| url | method |
| ----------|-------------------------------:|
| http://ip:port/interface/user/xxx.action | method|
首頁(yè)的活動(dòng)列表接口

請(qǐng)求參數(shù)

無(wú)

返回參數(shù)

  • errorcode 00 成功
  • msg
  • data 分類列表
    • id
    • img 活動(dòng)圖片
    • title 活動(dòng)名稱
    • desc 活動(dòng)的介紹、摘要
    • timeTag 時(shí)間安排， 如 活動(dòng)時(shí)間 10:26-20:00 或者報(bào)名截止日期： 10:26-20:00
    • fan 當(dāng)前參與人數(shù)
{
    "errorcode": 0,
    "msg": "提示",
    "data": [
        {
            "id": "dafdasdf",
            "desc": "武漢晚報(bào)訊（記者萬(wàn)勤）夫妻倆協(xié)議離婚后，為爭(zhēng)奪兒子的撫養(yǎng)權(quán)兩人對(duì)簿公堂，女方說(shuō)兒子非男方親生，經(jīng)親子鑒定竟真的如此，男方一怒之下索賠50萬(wàn)。",
            "title": "夫妻離婚爭(zhēng)撫養(yǎng)權(quán)發(fā)現(xiàn)兒子非親生 男子索賠50萬(wàn)",
            "timeTag": "直播時(shí)間 10:26-20:00",
            "fan": 342451,
            "img": "活動(dòng)圖片"
        }
    ]
}

5、點(diǎn)播分類首頁(yè)接口

| url | method |
| ----------|-------------------------------:|
| http://ip:port/interface/user/xxx.action | method|
點(diǎn)播分類接口展示點(diǎn)播界面的分類，點(diǎn)擊根據(jù)分類id能夠進(jìn)入響應(yīng)的分類

請(qǐng)求參數(shù)

無(wú)

返回參數(shù)

  • errorcode 00 成功
  • msg
  • data 分類列表
    • id
    • img 圖標(biāo)
    • title 標(biāo)題
    • subData 次級(jí)欄目信息
      • id 可以通過(guò)列表接口
      • title
{
    "errorcode": 0,
    "msg": "提示",
    "data": [
        {
            "id": "dafdasdf",
            "img": "xxx.jsg",
            "title": "體育",
            "subData": [
                {
                    "id": "l",
                    "title": "精選"
                },
                {
                    "id": 2,
                    "title": "熱門"
                }
            ]
        },
        {
            "id": "dafdasdf",
            "img": "xxx.jsg",
            "title": "經(jīng)濟(jì)",
            "subData": [
                {
                    "id": "l",
                    "title": "精選"
                },
                {
                    "id": 2,
                    "title": "熱門"
                }
            ]
        }
    ]
}
最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書(shū)系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Spring Cloud為開(kāi)發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見(jiàn)模式的工具（例如配置管理，服務(wù)發(fā)現(xiàn)，斷路器，智...
    卡卡羅2017閱讀 136,568評(píng)論 19贊 139
  • Android 自定義View的各種姿勢(shì)1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 179,058評(píng)論 25贊 709
  • 1. Java基礎(chǔ)部分 基礎(chǔ)部分的順序：基本語(yǔ)法，類相關(guān)的語(yǔ)法，內(nèi)部類的語(yǔ)法，繼承相關(guān)的語(yǔ)法，異常的語(yǔ)法，線程的語(yǔ)...
    子非魚(yú)_t_閱讀 34,706評(píng)論 18贊 399
  • 文/月方 阿潔，九十年代生女子，自小聰穎活潑，善于調(diào)停身邊各色孩子，是方圓有名的“孩子王”。但阿潔對(duì)學(xué)習(xí)卻相當(dāng)反感...
    月方閱讀 562評(píng)論 0贊 0
  • 有風(fēng)的日子， 一切東西， 都在奔跑…… 就讓你的夢(mèng)， 在那自然風(fēng)的吹拂下， 有多遠(yuǎn)就走多遠(yuǎn)， 在那看不到路的盡頭……
    小劇在成長(zhǎng)閱讀 303評(píng)論 0贊 6

友情鏈接更多精彩內(nèi)容