@xuduochoua
2015-11-05T08:56:34.000000Z
字数 4727
阅读 1323
国元APP商城接口文档
(仅供内部使用)
V 1.0
文档作者:徐久华 日期:2015/07/29
国元证券股份有限公司
版权所有不得复制
1.接口地址
本接口地址中的host: 60.174.200.98,端口port:8084
2.接口类型
2.1.APP类型列表接口
2.1.1请求
url 请求方式 备注
http://host:port/guoyuan/appstore/apptype/getList.html Get/post 获取app类型列表
参数列表
参数 参数说明 备注
无
json示例
{
}
2.1.2响应
参数 参数说明 备注
success 通信是否成功 true表示成功,false表示失败
errMsg 如果失败,返回错误信息。否则为空字符串
data 信息列表
信息简介 typeId 类型id
typeName 类型名称 0 我的应用、1办公…
showOrder 显示顺序
json示例
返回成功示例:
{
"errMsg": "",
"data": [{
"typeName": "我的应用",
"typeId": 0,
"showOrder": null
}, {
"typeName": "办公",
"typeId": 3,
"showOrder": "1"
}, {
"typeName": "金融",
"typeId": 1,
"showOrder": "2"
}
],
"success": true
}
2.4.登陆接口
2.4.1请求
url 请求方式 备注
http://host:port/guoyuan/appstore/clientuser/login.html post 登陆接口
参数列表
内部员工
参数 参数说明 备注
clientUserPhone 登录账号(oa工号)
clientUserPassword 密码(oa密码)
clientUserImei 手机imei
游客
参数 参数说明 备注
clientUserPhone 登录账号(手机imei)
clientUserPassword 密码(null)
clientUserImei 手机imei
json示例
{
" clientUserPhone ":xxx,
" clientUserPassword ":"xxxx",
" clientUserImei ":"xxxx"
}
2.4.2响应
参数 参数说明 备注
success 判断登陆是否成功 true表示成功,false表示失败
errMsg 如果登录失败,返回错误信息。否则为空字符串
data 用户相关数据信息
信息简介 id id
clientUserImei 手机唯一标识符
clientUserPhone 登录账号
clientUserRole 角色
clientUserType 用户类型
clientUserName
cuserId
cuserName
cdate 创建日期
json示例
1.返回成功示例:
{
"errMsg": "验证成功->登录成功",
"data": {
"id": 63,
"clientUserImei": "865411026881402", //手机唯一标识符
"clientUserRole": "0,1", // 角色
"clientUserPhone": "0254", // 登录账号
"clientUserPassword": null,
"clientUserType": 1, // 用户类型
"clientUserName": null,
"cuserId": 0,
"cuserName": null,
"cdate": 1445586687000
},
"success": true
}
2.返回失败示例:
{
"errMsg": "验证失败->登录失败",
"success": false
}
2.5.主页数据接口
2.5.1请求
url 请求方式 备注
http://host:port/guoyuan/appstore/getPageListByTypeLogin.html Get/Post 查询接口
参数列表
参数 参数说明 备注
clientUserId 用户id
typeId 类型id 1金融、2宣传、3办公、4服务
platformType 移动端平台 1 andorid、2 ios
json示例
{
" clientUserId ":xxx,
" typeId ":"xxxx",
" platformType ":"xxxx"
}
2.5.2响应
参数 参数说明 备注
success 判断登陆是否成功 true表示成功,false表示失败
errMsg 如果登录失败,返回错误信息。否则为空字符串
data 用户相关数据信息
信息简介 id id
name 应用名称
type 应用类型id 1金融、2宣传、3办公、4服务
typeName 应用类型名称
size 大小
classId 种类id 0 H5、1 APK
className 种类名称 APK、H5
url 应用下载地址
packageName 包名
logo 应用logo
addFlag 用户添加app标识
updateLog
iosOpenUrl Ios应用打开地址 IOS专用
updateRule 更新规则 0 默认、1 强制
versionCode 版本号
versionCode 版本名称
appStatusFlag 应用状态标识 0 安装、1 打开、2 更新
onclickCount 点击数
appDescribe 简介
accessRight 访问权限
platformType
detailDescribe 详情
detailImgUrls 详情图片集合
json示例
1、返回成功示例
{
"errMsg": "",
"data": {
"appList": [{
"name": "国元点金",
"id": 54,
"type": "1",
"typeName": "金融",
"size": "4.4M",
"className": "APK",
"url": "https://itunes.apple.com/cn/app/guo-yuan-dian-jin-yi-dong/id482531124?mt=8",
"packageName": "ios.com.guoyuanzq.dzh",
"logo": "e-log-icon-19.png",
"classId": "1",
"addFlag": "0",
"updateLog": null,
"iosOpenUrl": "ZQ8661iPhone://ZQ8661iPhone",
"updateRule": "0",
"versionName": "1.1",
"versionCode": 1,
"appStatusFlag": 0,
"onclickCount": 0,
"appDescribe": "专业化的手机炒股客户端软件产品。主要功能包括:自选股票,行情走势,全球市场,在线交易,理财中心,融资融券,国元资讯,服务互动,设置帮助等",
"accessRight": "10000000",
"platformType": 2,
"detailDescribe": null,
"detailImgUrl": null,
"detailImgUrls": []
}]
},
"success": true
}
2.6.类型更多数据接口
2.6.1请求
url 请求方式 备注
http://host:port/guoyuan/appstore/getByType.html Get/Post 查询接口
参数列表
参数 参数说明 备注
clientUserId 用户id
typeId 类型id 1金融、2宣传、3办公、4服务
platformType 平台 1 android、2 ios
json示例
{
" clientUserId ":xxx,
" typeId ":"xxxx",
" platformType ":"xxxx"
}
2.6.2响应
参数 参数说明 备注
appDetail 用户相关数据信息
信息简介 Id id
name 应用名称
type 应用类型id 1金融、2宣传、3办公、4服务
typeName 应用类型名称
size 大小
classId 种类id 0 H5、1 APK
className 种类名称 APK、H5
url 应用下载地址
packageName 包名
logo 应用logo
addFlag 用户添加app标识
updateLog
iosOpenUrl Ios应用打开地址 IOS专用
updateRule 更新规则 0 默认、1 强制
versionCode 版本号
versionCode 版本名称
appStatusFlag 应用状态标识 0 安装、1 打开、2 更新
onclickCount 点击数
appDescribe 简介
accessRight 访问权限
platformType
detailDescribe 详情
detailImgUrls 详情图片集合
json示例
1、返回成功示例
{
"errMsg": "",
"data": {
"appList": [{
"name": "国元点金",
"id": 54,
"type": "1",
"typeName": "金融",
"size": "4.4M",
"className": "APK",
"url": "https://itunes.apple.com/cn/app/guo-yuan-dian-jin-yi-dong/id482531124?mt=8",
"packageName": "ios.com.guoyuanzq.dzh",
"logo": "e-log-icon-19.png",
"classId": "1",
"addFlag": "0",
"updateLog": null,
"iosOpenUrl": "ZQ8661iPhone://ZQ8661iPhone",
"updateRule": "0",
"versionName": "1.1",
"versionCode": 1,
"appStatusFlag": 0,
"onclickCount": 0,
"appDescribe": "专业化的手机炒股客户端软件产品。主要功能包括:自选股票,行情走势,全球市场,在线交易,理财中心,融资融券,国元资讯,服务互动,设置帮助等",
"accessRight": "10000000",
"platformType": 2,
"detailDescribe": null,
"detailImgUrl": null,
"detailImgUrls": []
}]
},
"success": true
}
2.7.APP详情接口
2.7.1请求
url 请求方式 备注
http://host:port/guoyuan/appstore/getDetail.html Get/Post 查询接口
参数列表
参数 参数说明 备注
versionCode 版本号
packageName 包名
clientUserId 用户id
typeId 类型id 1金融、2宣传、3办公、4服务
platformType 平台 1 android、2 ios
json示例
{
" versionCode ":xxx,
" packageName ":xxx,
" clientUserId ":xxx,
" typeId ":"xxxx",
" platformType ":"xxxx"
}
2.7.2响应
参数 参数说明 备注
appDetail 用户相关数据信息
信息简介 Id id
name 应用名称
type 应用类型id 1金融、2宣传、3办公、4服务
typeName 应用类型名称
size 大小
classId 种类id 0 H5、1 APK
className 种类名称 APK、H5
url 应用下载地址
packageName 包名
logo 应用logo
addFlag 用户添加app标识
updateLog
iosOpenUrl Ios应用打开地址 IOS专用
updateRule 更新规则 0 默认、1 强制
versionCode 版本号
versionCode 版本名称
appStatusFlag 应用状态标识 0 安装、1 打开、2 更新
onclickCount 点击数
appDescribe 简介
accessRight 访问权限
platformType
detailDescribe 详情
detailImgUrls 详情图片集合