美文网首页
2018-06-12

2018-06-12

作者: hanguangdai | 来源:发表于2018-06-12 16:44 被阅读0次

[TOC]

文档使用说明

版本历史

日期 版本号 作者 备注
2018.6.11 1.0 daihanguang 新版本发布

文档介绍

  本文档的接口用于海外印尼项目，其中接口作为app与服务器的交互使用

接口约定

概述

  通过http请求，以JSON结构的数据进行交互

请求参数

所有请求的接口都只接收参数名为params的数据，其中params的值是JSON格式的字符串
请求范例：

{
    "data":{“数据信息”}，
    "token":""
}
说明：
data：输入参数
token：校验码
----------------------------------------------
所有的输入参数必须带入token参数，防止服务器被攻击；
token的生成规则：MD5(MD5(data+"ZBQB").TOUPERCASE()+"ZBQB")

返回结果

所有返回结果以 JSON 格式返回；

  1. 操作成功后返回，范例：
{
  "code": "0",//状态码
  "msg": "SUCCESS"//信息
  "data" : ""
}
  1. 成功返回数据，范例：
{
  "data": {//数据
    "name": "minhow",
    "age": "18"
  },
  "code": "0",//状态码
  "msg": "SUCCESS"//信息
}
  1. 验证失败返回，范例：
{
  "code": "-1",//错误状态码
  "code": "非法请求！"//错误信息
  "data" : ""
}
  1. 错误返回，范例：
{
  "code": "-1",//错误状态码
  "code": "系统处理异常！"//错误信息
  "data" : ""
}

全局响应状态码说明

状态码 说明
0 操作成功
-1 非法请求！
1 失败

主模块名称

说明：下方的请求参数都代表的是data里面的参数

登录

  • 功能描述

验证用户是否登录

  • 请求说明

请求方式：POST

请求URL ：/indonesiaApi/auth/v1/doLogin

  • 请求参数

字段 字段类型 字段说明
loginName string 手机号
loginPwd string 密码
mobileType string 设备名称

  • 返回结果

{
    code: "0"
    data: {
        customerid: 11
    }
    msg: "登录成功！"
}

  • 返回参数

字段 字段类型 字段说明
code String 请求结果状态码
msg String 请求结果消息
data JSON 请求结果数据

退出登录

  • 功能描述

退出登录

  • 请求说明

请求方式：POST

请求URL ：/indonesiaApi/auth/v1/loginOut

  • 请求参数

字段 字段类型 字段说明
customerid Integer 客户id

  • 返回结果

{
    "code":"0",
    "data":"",
    "msg":"退出成功！"
}

  • 返回参数

字段 字段类型 字段说明
code String 请求结果状态码
msg String 请求结果消息
data JSON 请求结果数据

获取验证码

  • 功能描述

注册或忘记密码的时候，获取短信验证码

  • 请求说明

请求方式：POST

请求URL ：/indonesiaApi/auth/v1/getRegisterSms

  • 请求参数

字段 字段类型 字段说明
mobilephone String 手机号
smstype String 短信类型，1代表注册，2代表忘记密码，3代表修改密码

  • 返回结果

{
    "code":"0",
    "data":{
        "enabletime":120,
        "mobilephone":"18565111221",
        "vcode":"6803"
    },
    "msg":"短信发送成功！"
}

  • 返回参数

字段 字段类型 字段说明
code String 请求结果状态码
msg String 请求结果消息
data JSON 请求结果数据

注册用户

  • 功能描述

通过手机号码注册用户

  • 请求说明

请求方式：POST

请求URL ：/indonesiaApi/auth/v1/register

  • 请求参数

字段 字段类型 字段说明
mobilephone String 手机号
vcode String 验证码
regip String 注册IP
regequip String 手机唯一码
regtype String 注册设备

  • 返回结果

{
    "code":"0",
    "data":{
        "customerid":12
    },
    "msg":"注册成功！"
}

  • 返回参数

字段 字段类型 字段说明
code String 请求结果状态码
msg String 请求结果消息
data JSON 请求结果数据

根据客户id修改用户密码

  • 功能描述

通过返回的客户id，修改新的密码

  • 请求说明

请求方式：POST

请求URL ：/indonesiaApi/auth/v1/updatePassByCustomerId

  • 请求参数

字段 字段类型 字段说明
customerid String 客户id
pwd String 新的密码
updatePwdType String 获取修改密码的类型：1代表注册完成后修改，2代表忘记密码的时候修改

  • 返回结果

{
    "code":"0",
    "data":"",
    "msg":"注册完成！"
}
或
{
    "code":"0",
    "data":"",
    "msg":"密码重置成功！"
}

  • 返回参数

字段 字段类型 字段说明
code String 请求结果状态码
msg String 请求结果消息
data JSON 请求结果数据

根据手机号和验证码验证手机是否存在

  • 功能描述

根据手机号和验证码验证手机是否存在，在忘记密码的功能模块使用

  • 请求说明

请求方式：POST

请求URL ：/indonesiaApi/auth/v1/forgetCheck

  • 请求参数

字段 字段类型 字段说明
mobilephone String 手机号
vcode String 验证码

  • 返回结果

{
    "code":"0",
    "data":{
        "customerid":12
    },
    "msg":"客户检验存在，可以修改密码！"
}

  • 返回参数

字段 字段类型 字段说明
code String 请求结果状态码
msg String 请求结果消息
data JSON 请求结果数据

首页

  • 功能描述

展示首页相关的信息

  • 请求说明

请求方式：POST

请求URL ：/indonesiaApi/home/v1/findIndexInfo

  • 请求参数

无参数（data:""）

  • 返回结果

{
    "code":"0",
    "data":{
        "contracturl":"http://192.168.1.250:8080/MobileAPI/contact.jsp", //合同查看地址
        "banners":[ //轮播图
            {
                "imgurl":"http://192.168.1.250:8080/HSImage/ShowImageBANNER/banner1.png", //图片下载链接地址
                "url":"" //点击图片跳转地址
            },
            {
                "imgurl":"http://192.168.1.250:8080/HSImage/ShowImageBANNER/banner2.png",
                "url":""
            }
        ],
        "products":{ //产品信息
            "maxlimit":"1000000", //最高额度
            "period":7, //借款时间
            "periodunit":"D", //借款单位
            "productid":1, //产品ID
            "name":"快速贷", //产品名称
            "remark":"快速贷", //产品描述
            "type":"1", //产品类型
            "loanPeriod":"7 D", //显示借款周期
            "minlimit":"500000" //最低额度
        }
    },
    "msg":"首页获取数据成功！"
}

  • 返回参数

字段 字段类型 字段说明
code String 请求结果状态码
msg String 请求结果消息
data JSON 请求结果数据

消息中心-展示消息列表

  • 功能描述

展示所有已读或未度的消息记录

  • 请求说明

请求方式：POST

请求URL ：/indonesiaApi/message/v1/queryMessages

  • 请求参数

字段 字段类型 字段说明
customerid String 客户id

  • 返回结果

{
    "code":"0",
    "data":[
        {
            "result":"0",
            "createtime":"2018-06-06 11:00:50",
            "id":9,
            "title":"注册时间标题",
            "content":"注册时间标题"
        },
        {
            "result":"1", //0代表未读，1代表已读
            "createtime":null, //创建时间
            "id":8,
            "title":"全局标题", //标题
            "content":"" //内容
        }
    ],
    "msg":"查询消息成功！"
}

  • 返回参数

字段 字段类型 字段说明
code String 请求结果状态码
msg String 请求结果消息
data JSON 请求结果数据

消息中心-标记消息是否已读

  • 功能描述

标记消息是否已读

  • 请求说明

请求方式：POST

请求URL ：/indonesiaApi/messageresult/v1/updateMessResult

  • 请求参数

字段 字段类型 字段说明
customerid String 客户id
messageid String 信息id

  • 返回结果

{
    "code":"0",
    "data":"",
    "msg":"标记消息成功！"
}

  • 返回参数

字段 字段类型 字段说明
code String 请求结果状态码
msg String 请求结果消息
data JSON 请求结果数据

申请贷款-查询贷款进度

  • 功能描述

查询对应客户的贷款进度，若传入的客户id为空，则返回登录的标记

  • 请求说明

请求方式：POST

请求URL ：/indonesiaApi/loaninfo/v1/queryLoanStatus

  • 请求参数

字段 字段类型 字段说明
customerid String 客户id

  • 返回结果

{
    "code":"0", 
    "data":{
        "loanMsg":"贷款业务已审核通过，可以签约并且打款！",
        "loanStatus":"A01", 
        // -1表示未找到登录的用户，
        // 0表示可以资料未补全，
        // 1表示可以进行贷款，提交贷款信息，
        // A00表示显示贷款申请审批中！
        // A01贷款业务已审核通过，可以签约并且打款！
        // A03表示客户确认打款，等待商家打款！
        // A04表示商家打款成功！
        // A02表示审核被拒！
        // A07表示驳回修改
        "isLoan":"0" //是否可贷款：0-否、1是
    },
    "msg":"查询订单状态成功"
}
或
{
    "code":"0",
    "data":{
        "loanMsg":"用户还未登录，请先登录！",
        "loanStatus":"-1"
    },
    "msg":"查询订单状态成功"
}

  • 返回参数

字段 字段类型 字段说明
code String 请求结果状态码
msg String 请求结果消息
data JSON 请求结果数据

申请贷款-生成借款单

  • 功能描述

展示信审过后，展示给手机端的借款信息

  • 请求说明

请求方式：POST

请求URL ：/indonesiaApi/loaninfo/v1/addLoanInfo

  • 请求参数

字段 字段类型 字段说明
customerid String 客户id
productid String 产品id
period String 借款周期
periodunit String 借款周期单位
loanmoney String 借款金额

  • 返回结果

{
    "code":"0",
    "data":"",
    "msg":"申请贷款成功！"
}

  • 返回参数

字段 字段类型 字段说明
code String 请求结果状态码
msg String 请求结果消息
data JSON 请求结果数据

申请贷款-马上签约-展示借款信息

  • 功能描述

展示信审过后，展示给手机端的借款信息

  • 请求说明

请求方式：POST

请求URL ：/indonesiaApi/loaninfo/v1/getLoanContractInfo

  • 请求参数

字段 字段类型 字段说明
customerid String 客户id

  • 返回结果

{
    "code":"0",
    "data":{
        "realpaymoney":15150, //预计还款金额
        "period":7, //周期
        "periodunit":"D",  //周期单位 默认天（D）
        "loanAgreementUrl":"http://192.168.1.250:8080/MobileAPI/loan.jsp", //借款协议地址
        "loanmoney":15000, //批准借款金额
        "name":"DAI",  //客户名称
        "loanperiod":"7 D", //显示周期
        "receivedmoney":9100, //实际收款数
        "bankname":"建设银行", //银行名称
        "cardno":"622700333344681", //银行卡号
        "bankcode":"CDC" //银行代码
    },
    "msg":"获取借款信息成功！"
}

  • 返回参数

字段 字段类型 字段说明
code String 请求结果状态码
msg String 请求结果消息
data JSON 请求结果数据

申请还款-展示还款信息

  • 功能描述

展示需要的还款信息

  • 请求说明

请求方式：POST

请求URL ：indonesiaApi/payinfo/v1/getPayInfo

  • 请求参数

字段 字段类型 字段说明
customerid String 客户id

  • 返回结果

{
    "code":"0",
    "data":{
        "loanmoney":15000, //批款金额
        "paymoney":15000, //付款金额
        "customerid":1111,
        "id":1013354,
        "status":"A04" //状态
    },
    "msg":"获取还款信息成功！"
}

  • 返回参数

字段 字段类型 字段说明
code String 请求结果状态码
msg String 请求结果消息
data JSON 请求结果数据

信息认证-用户认证结果

  • 功能描述

展示所有已经认证的状态

  • 请求说明

请求方式：POST

请求URL ：indonesiaApi/payinfo/v1/getPayInfo

  • 请求参数

字段 字段类型 字段说明
customerid String 客户id

  • 返回结果

{
    "code":"0",
    "data":{
        "status1":"0", //是否通过身份信息验证 0代表未认证 1代表认证通过
        "status2":"0", //是否通过个人信息验证 0代表未认证 1代表认证通过
        "status3":"1", //是否通过联系信息验证 0代表未认证 1代表认证通过
        "status4":"0", //是否通过工作信息验证 0代表未认证 1代表认证通过
        "status5":"1"   //是否通过银行信息验证 0代表未认证 1代表认证通过
        "status6":"0", //是否通过更多信息验证 0代表未认证 1代表认证通过
        "isedit":"1", //是否可编辑 0代表可编辑 1代表不可编辑
    },
    "msg":"获取验证信息成功！"
}

  • 返回参数

字段 字段类型 字段说明
code String 请求结果状态码
msg String 请求结果消息
data JSON 请求结果数据

信息认证-联系信息-展示联系人

  • 功能描述

展示信息认证中的所有联系人信息

  • 请求说明

请求方式：POST

请求URL ：indonesiaApi/contacts/v1/queryContacts

  • 请求参数

字段 字段类型 字段说明
customerid String 客户id

  • 返回结果

{
    "code":"0",
    "data":[
        {
            "address":"",
            "area":"",
            "city":"",
            "customerid":11,
            "id":13,
            "mobile":"18565111220",
            "name":"dhg",
            "province":"",
            "relation":"自己",
            "type":0,
            "unitaddress":""
        },
        {
            "address":"",  
            "area":"",
            "city":"",
            "customerid":11,
            "id":14,
            "mobile":"1856511220", //手机号
            "name":"g",  //名字
            "province":"",
            "relation":"自己", //关系
            "type":0,
            "unitaddress":""
        }
    ],
    "msg":"查询联系人成功！"
}

  • 返回参数

字段 字段类型 字段说明
code String 请求结果状态码
msg String 请求结果消息
data JSON 请求结果数据

信息认证-联系信息-添加联系人

  • 功能描述

展示信息认证中的所有联系人信息

  • 请求说明

请求方式：POST

请求URL ：indonesiaApi/contacts/v1/addContacts

  • 请求参数

字段 字段类型 字段说明
id String id（修改必须提交）
customerid String 客户id
name String 名字
relation String 关系
mobile String 手机号 
注意：里面data值的数据格式是JSON的数组类型，即data:[{"id":13,"customerid":11,"name":"dhg","relation":"自己","mobile":"18565111220"},{"id":14,"customerid":11,"name":"g","relation":"自己","mobile":"1856511220"}]}

  • 返回结果

{
code: "0"
data: ""
msg: "添加联系人信息成功！"
}

  • 返回参数

字段 字段类型 字段说明
code String 请求结果状态码
msg String 请求结果消息
data JSON 请求结果数据

信息认证-银行信息-查询银行卡记录

  • 功能描述

展示以前添加过的银行卡信息

  • 请求说明

请求方式：POST

请求URL ：/indonesiaApi/bankcard/v1/queryBankcards

  • 请求参数

字段 字段类型 字段说明
customerid String 客户id

  • 返回结果

{
    "code":"0",
    "data":{
        "bankcode":"CDC",   //银行卡号
        "bankname":"建设银行",  //银行名称
        "cardno":"622700333344681",  //银行卡号
        "cardtype":"1", //银行卡类型 1 是储蓄卡 2 是信用卡
        "customerid":11,
        "financiallimit":0,
        "id":2,
        "limitmoney":0,
        "phonenum":"",
        "repaymentdate":"",
        "status":0
    },
    "msg":"查询银行卡信息成功！"
}

  • 返回参数

字段 字段类型 字段说明
code String 请求结果状态码
msg String 请求结果消息
data JSON 请求结果数据

信息认证-银行信息-添加银行卡

  • 功能描述

提交银行卡信息

  • 请求说明

请求方式：POST

请求URL ：/indonesiaApi/bankcard/v1/addBankcards

  • 请求参数

字段 字段类型 字段说明
id String id（修改必须提交）
customerid String 客户id
bankcode String 银行代码
bankname String 银行名称
cardno String 银行卡号

  • 返回结果

{
    "code":"0",
    "data":"",
    "msg":"添加银行卡成功！"
}

  • 返回参数

字段 字段类型 字段说明
code String 请求结果状态码
msg String 请求结果消息
data JSON 请求结果数据

相关文章

网友评论

      本文标题：2018-06-12

      本文链接：https://www.haomeiwen.com/subject/tclreftx.html

      延伸阅读

      深度阅读

      • 您也可以注册成为美文阅读网的作者，发表您的原创作品、分享您的心情！

      栏目导航

      热点阅读

      关于我们|服务条款|联系我们|2018-06-12|投稿指南|网站地图|RSS订阅|排版工具|手机版

      提供经典美文摘抄,优美散文欣赏,现代诗歌精选,短篇小说,心情随笔,表白情书范文,故事会在线阅读欣赏

      Copyright © 2014-2023 Haomeiwen.com All Rights Reserved. 好美文阅读网 版权所有

      备案信息：桂公网安备 45052102000051号 · 桂ICP备13007215号-3

      本站所收录作品、热点评论等信息部分来源互联网，目的只是为了系统归纳学习和传递资讯

      所有作品版权归原创作者所有，与本站立场无关，如不慎侵犯了你的权益，请联系我们告知，我们将做删除处理！