介面測驗用例

請求結構
請求方法
支持 HTTP GET 方法發送請求,這種方式下請求引數需要包含在請求的 URL 中，支持 HTTP POST 方法發送請求,這種方式下請求引數需要包含在請求的 BODY 中，
字符編碼
請求及回傳結果都使用UTF-8字符集進行編碼，

公共引數

名稱 是否必須
描述
signature 是 簽名結果串(參考簽名機制)
timestamp 是 系統當前的Unix時間戳
nonce 是 亂數

lang
是 語言資訊,目前支持:zh(中文),en(英文),ar(阿拉伯文)
from 是 來源資訊,目前支持:android,ios

回傳結果

回傳的資料格式
呼叫成功回傳的資料格式為: JSON
回傳的資料結構

code(狀態碼)

狀態碼 描述
0 api不存在
1 操作成功
2 操作失敗
3 需要登錄
4 需要完善密碼
5 需要完善用戶資訊
6 不需要增加積分

message(相關提示)
以系統回傳的提示資訊為準
data(資料包)
狀態碼為0,2,3,4,5,6時,data為“空字串”
狀態碼為1時,將回傳資料包,若資料不存在,data為”空字串“
推薦串列
URL /app/v_1_1/article/recommendlist
請求方式
請求引數
名稱 是否必填項 描述 回傳狀態碼
id 是 欄目id 狀態碼 描述
start 是 文章開始位置,默認傳0,下次請求時,用本介面回傳值 1 操作成功,data為資料包
random 是 隨機開始值, 默認傳1,下次請求時,用本介面回傳值 2 操作失敗
point_time 是 節點時間,默認傳0,下次請求時,用本介面回傳值
token 否 用戶身份標識

回傳資料
{
‘code’: ‘1’,
‘message’: ‘成功提示’, ‘data’: {
‘start’: ‘下次請求文章開始位置’,
‘random’: ‘下次請求隨機開始值’, ‘point_time’: ‘下次請求使用的節點時間’, ‘more’: ‘是否有更多資料,1有,0沒有’, ‘banner_list’: [{//頁面頂部banner圖串列
‘id’: ‘文章id’,
‘theme’: ’ 文 章 標 題 ', ‘description’: ‘文章描述’, ‘image_url’: ‘文章預覽圖’,
‘is_good’: ‘是否點贊,1已點贊,0未點贊’, ‘is_collect’: ‘是否收藏,1已收藏,0未收藏’,
‘link’: ’ 文 章 鏈 接 ', ‘share_link’: ‘文章分享鏈接’,
},…],
‘flash_list’: [{//頁面中部跑馬燈串列(即時串列) ‘id’: ‘文章id’,
‘theme’: ’ 文 章 標 題 ‘, ‘description’: ‘文章描述’,
‘is_good’: ‘是否點贊,1已點贊,0未點贊’, ‘is_collect’: ‘是否收藏,1已收藏,0未收藏’, ‘link’: ‘文章鏈接’,
‘share_link’: ‘文章分享鏈接’,
},…],
‘article_list’: [{//文章串列’id’: ‘文章id’,
‘view_type’: ‘視圖型別:1左圖,2中間大圖,3右圖,4視頻,5即時’, ‘type’: ‘文章型別:1新聞,2快訊,3圖片,4視頻,5期刊,6專題’, ‘column_name’: ‘欄目分類’,
‘theme’: ’ 文 章 標 題 ', ‘description’: ‘文章描述’, ‘lead’: ‘導語’,
‘content’: ’ 文 章 內 容 ', ‘edit_time’: ‘文章發布時間’, ‘image_url’: ‘文章預覽圖’,
‘is_good’: ‘是否點贊,1已點贊,0未點贊’, ‘is_collect’: ‘是否收藏,1已收藏,0未收藏’, ‘link’: ‘文章鏈接’,
‘share_link’: ‘文章分享鏈接’,
},…],
‘flash_id’: ‘即時id’
視頻串列
URL /app/v_1_1/article/videolist
請求方式 get
請求引數
名稱 是否必填項 描述 回傳狀態碼 描述
start 是 文章開始位置,默認傳0,下次請求時,用本介面回傳值 1 操作成功,data為資料包
point_time 是 節點時間,默認傳0,下次請求時,用本介面回傳值 2 操作失敗
token 否 用戶身份標識

回傳資料
{
‘code’: ‘1’,
‘message’: ‘成功提示’, ‘data’: {
‘start’: ‘下次請求文章開始位置’,
‘point_time’: ‘下次請求使用的節點時間’, ‘more’: ‘是否有更多資料,1有,0沒有’, ‘list’: [{//文章串列
‘id’: ‘文章id’,
‘view_type’: ‘視圖型別:1左圖,2中間大圖,3右圖,4視頻,5即時’, ‘type’: ‘文章型別:1新聞,2快訊,3圖片,4視頻,5期刊,6專題’, ‘column_name’: ‘欄目分類’,
‘theme’: ’ 文 章 標 題 ', ‘description’: ‘文章描述’, ‘lead’: ‘導語’,
‘video_is_sans_href’: ‘視頻是否為外鏈,1是外鏈,0不是外鏈’, ‘video_url’: ‘視頻鏈接地址’,
‘image_url’: ‘視頻封面圖’,
‘is_good’: ‘是否點贊,1已點贊,0未點贊’, ‘is_collect’: ‘是否收藏,1已收藏,0未收藏’, ‘link’: ‘文章鏈接’,
‘share_link’: ‘文章分享鏈接’,
},…]
}
}

專題串列
URL /app/v_1_1/article/speciallist
請求方式 get
請求引數
名稱 是否必填項 描述 回傳狀態碼 描述
start 是 文章開始位置,默認傳0,下次請求時,用本介面回傳值 1 操作成功,data為資料包
point_time 是 節點時間,默認傳0,下次請求時,用本介面回傳值 2 操作失敗
token 否 用戶身份標識

回傳資料
{
‘code’: ‘1’,
‘message’: ‘成功提示’, ‘data’: {
‘start’: ‘下次請求文章開始位置’,
‘point_time’: ‘下次請求使用的節點時間’, ‘more’: ‘是否有更多資料,1有,0沒有’, ‘banner_list’: [{//頁面頂部banner圖串列
‘id’: ‘文章id’,
‘theme’: ’ 文 章 標 題 ', ‘description’: ‘文章描述’, ‘image_url’: ‘文章預覽圖’,
‘is_good’: ‘是否點贊,1已點贊,0未點贊’, ‘is_collect’: ‘是否收藏,1已收藏,0未收藏’, ‘link’: ‘文章鏈接’,
‘share_link’: ‘文章分享鏈接’,
},…],
‘list’: [{//文章串列
‘id’: ‘文章id’,
‘view_type’: ‘視圖型別:1左圖,2中間大圖,3右圖,4視頻,5即時’, ‘type’: ‘文章型別:1新聞,2快訊,3圖片,4視頻,5期刊,6專題’, ‘column_name’: ‘欄目分類’,
‘theme’: ’ 文 章 標 題 ', ‘description’: ‘文章描述’, ‘lead’: ’ 導 語 ', ‘image_url’: ‘文章預覽圖’,
‘is_good’: ‘是否點贊,1已點贊,0未點贊’, ‘is_collect’: ‘是否收藏,1已收藏,0未收藏’, ‘link’: ‘文章鏈接’,
‘share_link’: ‘文章分享鏈接’,
},…]

搜索頁串列
URL /app/v_1_1/article/search
請求方式 get
請求引數
名稱 是否必填項 描述 回傳狀態碼 描述
start 是 文章開始位置,默認傳0,下次請求時,用本介面回傳值 1 操作成功,data為資料包
point_time 是 節點時間,默認傳0,下次請求時,用本介面回傳值 2 操作失敗
keywords 否 搜索關鍵字
token 否 用戶身份標識
回傳值

{
‘code’: ‘1’,
‘message’: ‘成功提示’, ‘data’: {
‘start’: ‘下次請求文章開始位置’,
‘point_time’: ‘下次請求使用的節點時間’, ‘keywords’: ‘搜索的關鍵字’,
‘more’: ‘是否有更多資料,1有,0沒有’, ‘list’: [{//文章串列
‘id’: ‘文章id’,
‘view_type’: ‘視圖型別:1左圖,2中間大圖,3右圖,4視頻,5即時’, ‘type’: ‘文章型別:1新聞,2快訊,3圖片,4視頻,5期刊,6專題’, ‘column_name’: ‘欄目分類’,
‘theme’: ‘文章標題’,
‘description’: ‘文章描述’, ‘content’: ’ 文 章 內 容 ', ‘edit_time’: ‘文章發布時間’,
‘is_good’: ‘是否點贊,1已點贊,0未點贊’, ‘is_collect’: ‘是否收藏,1已收藏,0未收藏’, ‘link’: ‘文章鏈接’,
‘share_link’: ‘文章分享鏈接’,
‘image_url’: ‘文章預覽圖(系統會根據不同視圖型別,回傳不同大小的圖片)’,
},…]

用戶對文章進行點贊,點踩
URL /api/article/userevaluate
請求方式 post
請求引數
名稱 是否必填項 描述 回傳狀態碼 描述
id 是 文章id 1 操作成功,data為空字串
type 是 判斷是點贊還是點踩,1贊,2踩 2 操作失敗
token 是 用戶身份標識 3 需要登錄
回傳值
{
‘code’: ‘1’,
‘message’: ‘成功提示’,
‘data’: ‘’,
}

用戶收藏和取消收藏文章
URL /api/article/userevaluate
請求方式 post
請求引數
名稱 是否必填項 描述 回傳狀態碼 描述
id 是 文章id 1 操作成功,data為空字串
type 是 判斷是收藏還是取消收藏,1收藏,2取消收藏 2 操作失敗
token 是 用戶身份標識 3 需要登錄