通用App接口定义文档规范.docx
《通用App接口定义文档规范.docx》由会员分享，可在线阅读，更多相关《通用App接口定义文档规范.docx（21页珍藏版）》请在冰豆网上搜索。
通用App接口定义文档规范
阅读之前（必读*）：
1.所有接口返回数据格式为
{
code:
’0000’,
msg:
’’,
data:
{}
}
的形式其中code是响应码msg是响应消息默认正确响应无msg消息只有错误才有错误消息data为数据段.
Java段对应返回数据bean为如下形式。
2.响应码表对应code
StringSUCCESS="0000";
StringSUCCESS_MSG="成功";
StringERROR="0001";
StringERROR_MSG="失败";
StringPARAM_ERROR="0002";
StringPARAM_ERROR_MSG="参数错误或者参数不完整";
StringNO_PERMISSION="UP01";
StringNO_PERMISSION_MSG="无接口访问权限";
StringUE01="UE01";
StringUE01_MSG="未知接口异常";
测试服务器调试路径
登录逻辑附件如下：
1.接口服务器验证接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/loginvalidate
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
手机号
phoneNumber
字符串
2
token
token
字符串
需要返回的数据
{
"msg":
“成功”,
"code":
“0000”
data:
{
token:
’’
role:
’1’;
贝信息设置接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/setStudentInfo
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
token
字符串
3
学生姓名
name
字符串
4
性别
sex
字符串
5
班级名称
className
字符串
6
生日
birthday
字符串
需要返回的数据
{
"msg":
“成功”,
"code":
“0000”
}
3.学生卡主动定位接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/getCardLocation
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
token
字符串
需要返回的数据:
{
"batteryValue":
100,"coord":
{
"latitude":
"longitude":
}
},
4."updateTime":
.等等等
],
"updatetime":
"code":
‘0000’
‘msg’:
’成功’
}
5．亲情号设置接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/setQinqinghao
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
token
字符串
2
亲情号码
numbers
字符串
List的Json字符串
Qinqinghao{
name:
’妈妈’
phoneNum:
’’
}
需要返回的数据:
{
"code":
‘0000’
‘msg’:
’成功’
}
6.获取宝贝信息
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/getStudentInfo
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
Imei号
imei
Long
需要返回的数据:
{
"data":
{
"childBirthday":
1,
"childGrade":
"",
"childName":
"",
"childSex":
1
取上课隐身接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/getHide
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
token
字符串
需要返回的数据:
{
"count":
4,
"data":
[
{
"repeatCycleMode":
"012",
"timeEnd":
"19:
00",
"timeStart":
"8:
00",
“openState”:
0置上课隐身接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/setHide
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
token
字符串
2
上课隐身对象List
hideTimes
字符串
Listjson字符串
HideTime{
/**
*开始小时
*/
privateintstartHour;
/**
*开始分钟
*/
privateintstartMinute;
/**
*结束小时
*/
privateintendHour;
/**
*结束分钟
*/
privateintendMinute;
/**
*模式，参考本类静态变量
*/
privateintmode;
privateStringenabled;表示是否启用字符串1表示启用，0表示不启用
}
9.获取闹钟接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/getClock
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
token
字符串
需要返回的数据:
{
"count":
2,
"data":
[
{
"alarmsName":
"起床",
"openState":
true,
"repeatCycleMode":
"012",
"time":
"9:
00"
},
{
"alarmsName":
"午休",
"openState":
false,
"repeatCycleMode":
"234",
"time":
"10:
00"
}
],
"code":
200
"msg":
成功
}
10.设置闹钟接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/setClock
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
token
字符串
2
闹钟身对象List
clocks
字符串
Listjson字符串
Clock{
"alarmsName":
"起床",
"openState":
true,
"repeatCycleMode":
"012",
"time":
"9:
00"
}
11.获取一键拨号接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/getOneKey
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
Imei号
imei
Long
需要返回的数据:
{
"data":
[‘’,’’,’’,’’]置一键拨号接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/setOneKey
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
token
字符串
2
一键拨号
onekeys
字符串
4位的电话号码数字没有的填0
例如:
0,,0,
代笔#1为空#2#3为空#4
13.设置休眠接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/setSleep
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
Imei号
imei
Long
2
是否休眠
isSleep
Boolean
是否休眠
需要返回的数据:
{
"code":
‘0000’
"msg":
成功
}
14.发起远程监听接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/getRemoteMonitoring
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
token
字符串
2
类型
type
String
1代表录音
2代表电话回拨
3
电话号码
phoneNumber
String
回拨的电话号码
需要返回的数据:
{
"code":
‘0000’
"msg":
成功
}
15.远程关机接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/remoteClose
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
token
字符串
2
phoneNumber
手机号
字符串
需要返回的数据:
{
"code":
‘0000’
"msg":
成功
}
16.意见反馈接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/suggest
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
token
字符串
可选
2
phoneNumber
手机号
字符串
必填
3
content
内容
字符串
长度大于10个字（必填）
4
imgFile
图片
二进制数据
可选
需要返回的数据:
{
"code":
‘0000’
"msg":
成功
}
17.学生卡解绑接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/unBind
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
token
字符串
必填
2
adminNumber
管理员手机号
LONG
必填
3
password
管理员密码
字符串
必填
需要返回的数据:
{
"code":
‘0000’
"msg":
成功
}
18.更换管理员号码
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/changeAdminNumber
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
token
字符串
必填
2
oldAdminNumber
老管理员号码
LONG
必填
3
newAdminNumber
新管理员号码
LONG
必填
4
password
管理员密码
字符串
必填
5
deleteHistory
是否删除历史轨迹
BOOLEAN
必填（true,false）
6
smsValidateCode
短信验证码
字符串
必填
需要返回的数据:
{
"code":
‘0000’
"msg":
成功
}
19．获取休眠接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/getSleep
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
需要返回的数据:
{
"code":
‘0000’
"msg":
成功
“data”:
”true”询蓝牙状态接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/queryBlueTooth
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
需要返回的数据:
{
"code":
‘0000’
"msg":
成功
“data”:
”1”置蓝牙接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/setBlueTooth
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
2
on
开启、关闭
Boolean
True,false
需要返回的数据:
{
"code":
200
"msg":
成功
}
22.设置定位周期接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/setDingWeiPeriod
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
2
second
秒数
int
需要返回的数据:
{
"code":
‘0000’
"msg":
成功
}
23.获取短信验证码
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/getVaildCode
输入字段定义
序号
字段名称
字段定义
数据类型
备注
2
phoneNumber
手机号码
Long
1
token
需要返回的数据:
{
"code":
‘0000’
"msg":
成功
}
24.设置音量
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/setVolume
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
2
naozhongVolume
闹钟音量
int
3
xianglingVolume
响铃音量
int
4
tonghuaVolume
通话音量
int
需要返回的数据:
{
"code":
‘0000’
"msg":
成功
}
25.获取音量
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/getVolume
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
需要返回的数据:
{
"code":
‘0000’
"msg":
成功
“data”:
”7;7;7”;置自动开关机
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/setPowerOnOff
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
2
powerOnOff
powerOnOff
PowerOnOff对象
PowerOnOff{
privatelongimei;
privateintonHour;
privateintonMinute;
/**
*模式,以7个0或者1表示，单次不重复是0000000,每星期二星期三重复是0110000
*/
privateStringonMode;
privatebooleanonEnabled;
privateintoffHour;
privateintoffMinute;
privateStringoffMode;
privatebooleanoffEnabled;
}
取自动开关机
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/getAutoPowerOnOff
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
需要返回的数据:
{
"code":
‘0000’
"msg":
成功
“data”:
{imei:
onHour:
1……}询话费
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/card/queryLeftMoney
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
需要返回的数据:
{
"code":
‘0000’
"msg":
成功
}
升级会员 