1.1.1協(xié)議說明
服務(wù)器端同客戶端的數(shù)據(jù)交互采取HTTP/HTTPS為基礎(chǔ)的REST接口方式。REST請求僅支持POST請求。同時，每個請求均需要滿足以下的請求報頭要求：
請求頭
參數(shù)描述
參數(shù)要求
Host
用于指定被請求資源的Internet主機和端口號，通常從請求HTTP URL中自動提取。
類型：String
默認值：HTTP 1.1版本自動從HTTP URL中提取可選
Content-Length
用于指明實體正文（不包括實體報頭）的長度,在上傳文件數(shù)據(jù)為必選。
類型：String
默認值：無條件必選
Content-Type
指明發(fā)送給接收者的實體正文媒體類型，如application/json，所有接口中除了上傳數(shù)據(jù)接口外，均要求application/json。
類型：String
默認值：無必選
Authorization
描述客戶端授權(quán)信息以及用來證明請求的完整和正確性。
類型：String
默認值：無必選（login除外）
1.1.2數(shù)據(jù)格式說明
對于所有的JSON數(shù)據(jù)格式，采取以下的json數(shù)據(jù)格式：
請求：
{
header: {
userId:“userid”
token:“l(fā)ogin token”
}
Body: {
xx :“XX”,
…
}
}
詳細描述：
l對于所有的字段名稱為小寫
l對于所有的請求，都需要包含header域，其中，header中還需要包含userId和token。對于login請求的token為空。
l對于具體的請求，具體的數(shù)據(jù)域和類型在body域中定義。
應(yīng)答：
{
Header: {
Error: 0
str:“Ok”
}
Body: {
xx :“XX”,
…
}
}
或者：
{
Header: {
Error: 1
str:“user not found”
}
}
詳細描述：
l對于所有的字段名稱為小寫
l對于所有的應(yīng)答，都需要包含header域，其中，header中還需要包含error和str。其中error表示請求的正確與否以及對應(yīng)的出錯碼，具體的出錯碼定義見后續(xù)章節(jié)。
l對于具體的應(yīng)答，具體的數(shù)據(jù)域和類型在body域中定義。
1.1接口定義
1.1.1用戶信息
1.1.1.1用戶登陸（11月23日）*VC
URL:HTTPS://host:port/api/v2/auth/login
METHOD: post
請求參數(shù)為：
字段名
參數(shù)類型
參數(shù)說明
loginName
string
用戶登陸名，訪問系統(tǒng)的名稱，郵箱，手機號。不等同于user_account
password
String
(len_info)+Md5+(len_info)
len_info
Int
1-9
type
int
0,1,2,3
openstr
String
第三方登錄串
string
客戶端版本號：
1:PC
2:android
3:ios
clientName
string
客戶端名稱,PC機器名,手機型號
clientOS
string
客戶端操作系統(tǒng)
string
客戶端唯一序列號
應(yīng)答：
字段名
參數(shù)類型
參數(shù)說明
result
int
0:成功
1:密碼不對
2:用戶不存在
3:其他
userid
string
用戶ID
token
string
有效token
舉例：
請求：HTTPS://host:port/api/v1/auth/login
POST數(shù)據(jù)為：
{
header: {
userId:“”
token:“”
}
Body: {
loginName:“張三”
password:“pass123”
clientType:“2”
clientName:“Huawei P8”
clientOS:“Android 5.0”
clientSN:“ASfd3daRfdadsfdaRda”
}
}
應(yīng)答數(shù)據(jù)為：
{
Header: {
Error: 0
str:“Ok”
}
Body: {
Userid:“0123456”,
userName:“張三”
}
}
應(yīng)答錯誤為：
{
Header: {
Error: 1
str:“Invalid password”
}
}
1.1.1.2用戶注冊（11月23日）*VC
URL:HTTPS://host:port/api/v2/auth/register
METHOD: post
請求參數(shù)為：
字段名
參數(shù)類型
參數(shù)說明
phone
string
手機號
nickname
string
用戶昵稱
password
String
密碼
verify
string
短信驗證碼
{"header":{"userid":"","token":""},"body":{"phone":"13545856122","password":"123456","nickname":"呵呵","verify":"111111"}}
成功應(yīng)答：
字段名
參數(shù)類型
參數(shù)說明
Result
int
0:成功
1:用戶已注冊
2: sms號碼不對
3：號碼錯誤
userid
string
用戶ID
token
string
有效token
失敗應(yīng)答：
字段名
參數(shù)類型
參數(shù)說明
無
舉例：
請求：HTTPS://host:port/api/v1/auth/register
POST數(shù)據(jù)為：
{
header: {
userId:“”
token:“”
}
Body: {
phone:" 13881234567",
password:“pass123”,
verify:“1232”
}
}
應(yīng)答數(shù)據(jù)為：
{
Header: {
code: 0
msg:“Ok”
}
Body: {
Userid:“0123456”,
userName:“張三”
}
}
1.1.1.3獲取短信驗證碼（11月23日）*V
URL:HTTPS://host:port/api/v2/auth/smscode
METHOD:post
請求參數(shù)為：
字段名
參數(shù)類型
參數(shù)說明
phone
string
手機號
Reason
Int
0：注冊
1：忘記密碼
2：…
成功應(yīng)答：
字段名
參數(shù)類型
參數(shù)說明
Result
Int
0：成功
1：失敗，時間沒超過60秒間隔
2：其他
舉例：
請求：HTTPS://host:port/api/v1/auth/smscode
POST數(shù)據(jù)為：
{
header: {
userId:“”
token:“”
}
Body: {
phone:" 13881234567"
reason:0
}
}
應(yīng)答數(shù)據(jù)為：
{
Header: {
code: 0
msg:“Ok”
}
}
1.1.1.4獲取用戶信息（11月24日）*VC
URL:HTTPS://host:port/api/v2/auth/get_user_info
METHOD: post
請求參數(shù)為：
字段名
參數(shù)類型
參數(shù)說明
user_id
string
頭像對應(yīng)id
Token
string
成功應(yīng)答：
字段名
參數(shù)類型
參數(shù)說明
uname
Int
nikename
string
head
string
1.1.1.5修改用戶頭像（11月24日）*VC
URL:HTTPS://host:port/api/v2/auth/change_user_cover
METHOD: post
請求參數(shù)為：
字段名
參數(shù)類型
參數(shù)說明
user_id
string
頭像對應(yīng)id
Image
String
頭像二進制數(shù)據(jù)的base64編碼
成功應(yīng)答：
字段名
參數(shù)類型
參數(shù)說明
注意：只能修改本人的頭像，不能修改其他人的頭像。
1.1.1.6修改用戶基本信息（11月24日）*VC
URL:HTTPS://host:port/api/v2/auth/change_user_info
METHOD: post
請求參數(shù)為：
字段名
參數(shù)類型
參數(shù)說明
user_id
string
用戶id
Nickname
String
昵稱
成功應(yīng)答：
字段名
參數(shù)類型
參數(shù)說明
Result
Int
0：成功
1：昵稱重復(fù)
1.1.1.7第三方登錄綁定賬號（11月25日）
//TODO
1.1.1.8修改密碼(11月25日)*V
URL:HTTPS://host:port/api/v2/auth/change_pass
METHOD: post
請求參數(shù)為：
字段名
參數(shù)類型
參數(shù)說明
user_id
string
對應(yīng)id
newpass
String
新密碼
oldpas
String
舊密碼
成功應(yīng)答：
字段名
參數(shù)類型
參數(shù)說明
Result
Int
0：成功
1：舊密碼不對
1.1.1.9短信修改密碼(11月25日)*V
URL:HTTPS://host:port/api/v2/auth/sms_pass
METHOD: post
請求參數(shù)為：
字段名
參數(shù)類型
參數(shù)說明
Phone
string
手機號
newpass
String
新密碼
verify
String
短信驗證碼
成功應(yīng)答：
字段名
參數(shù)類型
參數(shù)說明
Result
Int
0：成功
1：驗證碼不對
1.1.2視頻資訊
1.1.2.1初始化接口
HTTPS://host:port/index.php/baseinfo/init
應(yīng)答數(shù)據(jù)為：
應(yīng)答數(shù)據(jù)為：
{
Header: {
code: 0
msg:“ok”
}
Body: {
systime:123456系統(tǒng)時間
api：https://app.17ok.com/index.php接口地址
version:10版本號
version_show:顯示的版本號
//啟動頁廣告設(shè)置
index_ad: [
{
type:1 // 1圖片
url:"跳轉(zhuǎn)地址"
als:"資源地址"
},
]}
}
