保理项目用户端接口
1. 说明
接口IP
完整路径如
POST请求的Header默认
Content-Type: application/json
登录成功后返回的 toke****n 是用户的凭证,除了注册、登录、验证码外所有需要权限的请求都需要请求头:
X-Token: [REDACTED]
系统错误的返回,请求了错误的地址,比如没传参数,或者请求方法不对
{
"meta": {
"code": 5000,
"msg": "内部错误"
},
"data": ""
}
2. 获取手机验证码(GET)
正确请求
/api/sms/getsms?phoneNumber=123
返回结果
{
"meta": {
"code": 2000,
"msg": "OK"
},
"data": {
"smsCode": "209302",
"resCode": 1,
"resMsg": "请求成功"
}
}
错误请求
/api/sms/getsms?phoneNumber=
返回结果
{
"meta": {
"code": 2000,
"msg": "OK"
},
"data": {
"resCode": 0,
"resMsg": "请求失败,手机号不能为空"
}
}
3. 个人注册(POST)
正确请求
/api/register/person
参数
{
"idNumber": "123",
"phoneNumber": "456",
"password": "[REDACTED]"
}
返回结果
{
"meta": {
"code": 2000,
"msg": "OK"
},
"data": {
"resCode": 1,
"resMsg": "注册成功"
}
}
4. 企业注册(POST)
正确请求
/api/register/company
参数
{
"uniformSocialCreditCode": "123",
"operatorIdNumber": "456",
"phoneNumber": "789",
"password": "[REDACTED]"
}
返回结果
{
"meta": {
"code": 2000,
"msg": "OK"
},
"data": {
"resCode": 1,
"resMsg": "注册成功"
}
}
5. 个人用户登录(POST)
请求参数
{
"phoneNumber": "456",
"password": "[REDACTED]"
}
登录成功
{
"meta": {
"code": 2000,
"msg": "OK"
},
"data": {
"resCode": 1,
"resMsg": "登录成功",
"token": "[REDACTED]"
}
}
密码失败
{
"meta": {
"code": 2000,
"msg": "OK"
},
"data": {
"resCode": 0,
"resMsg": "登录失败,密码错误",
"token": ""
}
}
6. 企业用户登录(POST)
7. 获取图形验证码(GET)
正确请求
/api/sms/getcode
返回结果
{
"meta": {
"code": 2000,
"msg": "OK"
},
"data": {
"image": "iVBORw0KGgoAAAANSUhEUgAAAMgAA ... ",
"code": "aaab",
"resCode": 1,
"resMsg": "图形验证码"
}
}