1.1.1协议说明
服务器端同客户端的数据交互采取HTTP/HTTPS为基础的REST接口方式。REST请求仅支持POST请求。同时，每个请求均需要满足以下的请求报头要求：
请求头
参数描述
参数要求
Host
用于指定被请求资源的Internet主机和端口号，通常从请求HTTP URL中自动提取。
类型：String
默认值：HTTP 1.1版本自动从HTTP URL中提取可选
Content-Length
用于指明实体正文（不包括实体报头）的长度,在上传文件数据为必选。
类型：String
默认值：无条件必选
Content-Type
指明发送给接收者的实体正文媒体类型，如application/json，所有接口中除了上传数据接口外，均要求application/json。
类型：String
默认值：无必选
Authorization
描述客户端授权信息以及用来证明请求的完整和正确性。
类型：String
默认值：无必选（login除外）
1.1.2数据格式说明
对于所有的JSON数据格式，采取以下的json数据格式：
请求：
{
header: {
userId:“userid”
token:“login token”
}
Body: {
xx :“XX”,
…
}
}
详细描述：
l对于所有的字段名称为小写
l对于所有的请求，都需要包含header域，其中，header中还需要包含userId和token。对于login请求的token为空。
l对于具体的请求，具体的数据域和类型在body域中定义。
应答：
{
Header: {
Error: 0
str:“Ok”
}
Body: {
xx :“XX”,
…
}
}
或者：
{
Header: {
Error: 1
str:“user not found”
}
}
详细描述：
l对于所有的字段名称为小写
l对于所有的应答，都需要包含header域，其中，header中还需要包含error和str。其中error表示请求的正确与否以及对应的出错码，具体的出错码定义见后续章节。
l对于具体的应答，具体的数据域和类型在body域中定义。
1.1接口定义
1.1.1用户信息
1.1.1.1用户登陆（11月23日）*VC
URL:HTTPS://host:port/api/v2/auth/login
METHOD: post
请求参数为：
字段名
参数类型
参数说明
loginName
string
用户登陆名，访问系统的名称，邮箱，手机号。不等同于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
客户端操作系统
string
客户端唯一序列号
应答：
字段名
参数类型
参数说明
result
int
0:成功
1:密码不对
2:用户不存在
3:其他
userid
string
用户ID
token
string
有效token
举例：
请求：HTTPS://host:port/api/v1/auth/login
POST数据为：
{
header: {
userId:“”
token:“”
}
Body: {
loginName:“张三”
password:“pass123”
clientType:“2”
clientName:“Huawei P8”
clientOS:“Android 5.0”
clientSN:“ASfd3daRfdadsfdaRda”
}
}
应答数据为：
{
Header: {
Error: 0
str:“Ok”
}
Body: {
Userid:“0123456”,
userName:“张三”
}
}
应答错误为：
{
Header: {
Error: 1
str:“Invalid password”
}
}
1.1.1.2用户注册（11月23日）*VC
URL:HTTPS://host:port/api/v2/auth/register
METHOD: post
请求参数为：
字段名
参数类型
参数说明
phone
string
手机号
nickname
string
用户昵称
password
String
密码
verify
string
短信验证码
{"header":{"userid":"","token":""},"body":{"phone":"13545856122","password":"123456","nickname":"呵呵","verify":"111111"}}
成功应答：
字段名
参数类型
参数说明
Result
int
0:成功
1:用户已注册
2: sms号码不对
3：号码错误
userid
string
用户ID
token
string
有效token
失败应答：
字段名
参数类型
参数说明
无
举例：
请求：HTTPS://host:port/api/v1/auth/register
POST数据为：
{
header: {
userId:“”
token:“”
}
Body: {
phone:" 13881234567",
password:“pass123”,
verify:“1232”
}
}
应答数据为：
{
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
请求参数为：
字段名
参数类型
参数说明
phone
string
手机号
Reason
Int
0：注册
1：忘记密码
2：…
成功应答：
字段名
参数类型
参数说明
Result
Int
0：成功
1：失败，时间没超过60秒间隔
2：其他
举例：
请求：HTTPS://host:port/api/v1/auth/smscode
POST数据为：
{
header: {
userId:“”
token:“”
}
Body: {
phone:" 13881234567"
reason:0
}
}
应答数据为：
{
Header: {
code: 0
msg:“Ok”
}
}
1.1.1.4获取用户信息（11月24日）*VC
URL:HTTPS://host:port/api/v2/auth/get_user_info
METHOD: post
请求参数为：
字段名
参数类型
参数说明
user_id
string
头像对应id
Token
string
成功应答：
字段名
参数类型
参数说明
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
请求参数为：
字段名
参数类型
参数说明
user_id
string
头像对应id
Image
String
头像二进制数据的base64编码
成功应答：
字段名
参数类型
参数说明
注意：只能修改本人的头像，不能修改其他人的头像。
1.1.1.6修改用户基本信息（11月24日）*VC
URL:HTTPS://host:port/api/v2/auth/change_user_info
METHOD: post
请求参数为：
字段名
参数类型
参数说明
user_id
string
用户id
Nickname
String
昵称
成功应答：
字段名
参数类型
参数说明
Result
Int
0：成功
1：昵称重复
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
请求参数为：
字段名
参数类型
参数说明
user_id
string
对应id
newpass
String
新密码
oldpas
String
旧密码
成功应答：
字段名
参数类型
参数说明
Result
Int
0：成功
1：旧密码不对
1.1.1.9短信修改密码(11月25日)*V
URL:HTTPS://host:port/api/v2/auth/sms_pass
METHOD: post
请求参数为：
字段名
参数类型
参数说明
Phone
string
手机号
newpass
String
新密码
verify
String
短信验证码
成功应答：
字段名
参数类型
参数说明
Result
Int
0：成功
1：验证码不对
1.1.2视频资讯
1.1.2.1初始化接口
HTTPS://host:port/index.php/baseinfo/init
应答数据为：
应答数据为：
{
Header: {
code: 0
msg:“ok”
}
Body: {
systime:123456系统时间
api：https://app.17ok.com/index.php接口地址
version:10版本号
version_show:显示的版本号
//启动页广告设置
index_ad: [
{
type:1 // 1图片
url:"跳转地址"
als:"资源地址"
},
]}
}
网友评论