@sewise-dev
2018-10-14T03:35:10.000000Z
字数 13119
阅读 1077
知识元
编号 | 版本 | 说明 | 作者 | 日期 |
---|---|---|---|---|
1 | v1.0 | 1.创建文档 | Seven | 2017-10-18 |
每次调用接口时,可能获得正确或错误的返回码,开发者可以根据返回码信息调试接口,排查错误。
返回码 | 说明 |
---|---|
-1 | 系统繁忙,此时请开发者稍候再试 |
0 | 请求失败 |
1 | 请求成功 |
200 | 响应成功 |
403 | 禁止访问 |
404 | 异常错误 |
500 | 数据验证错误 |
40001 | 不合法的凭证,或者access_token无效。 |
40004 | 不合法请求 |
HTTP请求状态返回格式
返回字段 | 字段类型 | 说明 |
---|---|---|
status | Integer | 请求返回码(详细请见状态表) |
message | String | 返回描述 |
data | Array | 返回结果 |
错误样例
{
"status": 40013,
"message": {"0":"invalid appid"}
}
成功样例
{
"status": 200,
"data": {"access_token":"ACCESS_TOKEN","expires_in":7200}
}
/v1/wxpay/unifiedorder
application/json
POST
参数 必选 类型 说明 RequestBody access_token 是 String 用户授权签名 orderName 是 String 订单/商品描述 orderType 是 String 订单类型:normal(普通),speech(语音识别),course(课程),swl(课时),knowledge(知识点),live(直播) totalFee 是 decimal 订单金额(元) deviceInfo 否 String 设备信息 productId 否 String 商品id(如course_id) ip 否 String 终端IP businessUserId 否 String 商家标识,如openid、userId business 否 String 商家名称
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 返回状态码 |
message | String | 返回错误信息 |
data | Array | 返回结果 |
Request
curl -X GET -H "Content-Type:application/json" -d http://api.sewise.com/v1/wxpay/unifiedorder?access_token=xxx
Response
{"status":200,"message":"\u4e0b\u5355\u6210\u529f","data":{"code_url":"weixin:\/\/wxpay\/bizpayurl?pr=n43DmWu"}}
/v1/wxpay/qrcode
application/json
GET
参数 必选 类型 说明 RequestBody code_url 是 String 支付短地址
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 返回状态码 |
message | String | 返回错误信息 |
data | Array | 返回结果 |
Request
curl -X GET -H "Content-Type:application/json" -d http://api.sewise.com/v1/wxpay/qrcode?code_url=weixin://wxpay/bizpayurl?pr=n43DmWu
/v1/wxpay/appUnifiedOrder
application/json
POST
参数 必选 类型 说明 RequestBody access_token 是 String 用户授权签名 orderName 是 String 订单/商品描述 orderType 是 String 订单类型:normal(普通),speech(语音识别),course(课程),swl(课时),knowledge(知识点),live(直播) totalFee 是 decimal 订单金额(元) deviceInfo 否 String 设备信息 productId 否 String 商品id(如course_id) ip 否 String 终端IP businessUserId 否 String 商家标识,如openid、userId business 否 String 商家名称
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 返回状态码 |
message | String | 返回错误信息 |
data | Array | 返回结果 |
Request
curl -X GET -H "Content-Type:application/json" -d http://api.sewise.com/v1/wxpay/appUnifiedOrder
Response
{"status":200,"message":"\u4e0b\u5355\u6210\u529f","data":{"appid":"wxe1353733a25a225a",
"mch_id":"1492814002",
"nonce_str":"hjSWcBSiyfALsK0l",
"prepay_id":"wx201711251204331029b23fcd0292945536",
"result_code":"SUCCESS",
"return_code":"SUCCESS",
"return_msg":"OK",
"sign":"BDB2B3F9E897B0F87D39EA3CB3D6D31F",
"trade_type":"APP"}}
/v1/wxpay/miniUnifiedOrder
application/json
POST
参数 必选 类型 说明 RequestBody access_token 是 String 用户授权签名 openid 否 String 用户openid,如果access_token没有则必须传 orderName 是 String 订单/商品描述 orderType 是 String 订单类型:normal(普通),speech(语音识别),course(课程),swl(课时),knowledge(知识点),live(直播),toy(玩具) totalFee 是 decimal 订单金额(元) deviceInfo 否 String 设备信息 productId 否 String 商品id(如course_id) number 否 Int 数量 ip 否 String 终端IP businessUserId 否 String 商家标识,如openid、userId business 否 String 商家名称 distributorUserId 否 String 分享者userId distributor 否 String 分享者昵称 relationId 否 String 关联Id(如分享链接id、推广链接id等) relationUserId 否 String 关联者userId(渠道商、体验者、推广者) relationtor 否 String 关联者名称 recipients 否 String 收件人 mobile 否 String 收件人联系方式 address 否 String 收货地址
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 返回状态码 |
message | String | 返回错误信息 |
data | Array | 返回结果 |
Request
curl -X GET -H "Content-Type:application/json" -d http://api.sewise.com/v1/wxpay/miniUnifiedOrder
Response
{"status":200,"message":"\u4e0b\u5355\u6210\u529f","data":{"appId":"wx1e77d8b41a555b54","nonceStr":"e4e01muc40v0ad593ea7dgmq2n66k4yr","package":"prepay_id=wx20171222113926b5a05da8a60215295518","signType":"MD5","timeStamp":"1513913966","paySign":"4F27E577A9B40303AA91E6380528A6FD"}}
/v1/alipay/pay
application/json
POST/GET
参数 必选 类型 说明 RequestBody access_token 是 String 用户授权签名 orderName 是 String 订单/商品描述 orderType 是 String 订单类型:normal(普通),speech(语音识别),course(课程),swl(课时),knowledge(知识点),live(直播) totalFee 是 decimal 订单金额(元) deviceInfo 否 String 设备信息 productId 否 String 商品id(如course_id) ip 否 String 终端IP businessUserId 否 String 商家标识,如openid、userId business 否 String 商家名称
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 返回状态码 |
message | String | 返回错误信息 |
data | Array | 返回结果 |
Request
curl -X POST -H "Content-Type:application/json" -d http://api.sewise.com/v1/alipay/pay?access_token=xxx
Response
{"status":200,"message":"\u4e0b\u5355\u6210\u529f","data":{"code_url":"alipay_sdk=alipay-sdk-php-20161101&app_id=2017101709360186&biz_content=%7B%22body%22%3A%22course%22%2C%22subject%22%3A%22%5Cu7535%5Cu529b%5Cu7cfb%5Cu7edf%5Cu9884%5Cu6d4b%5Cu8bfe%5Cu7a0b%22%2C%22out_trade_no%22%3A%221709360186201710201333422890%22%2C%22total_amount%22%3A%220.01%22%2C%22product_code%22%3A%22QUICK_MSECURITY_PAY%22%7D&charset=UTF-8&format=json&method=alipay.trade.app.pay¬ify_url=http%3A%2F%2Fvtest.sewise.com.cn%2Fv1%2Falipay%2Fnotify&sign_type=RSA2×tamp=2017-10-20+13%3A33%3A49&version=1.0&sign=DvgQ0L6NkX8tLiO6E8FVa2QvT7JQ6Vqwll92RTQsgoxu3JRIM%2FuC94x4dgPTHL6S6XA44m9qV3euO70SrMjQOE%2FRSiwmxryAkaDPLtieAKF9XIZufQTKwC3Xr2xuIN84AYySvsEzk4nddAmorAeLka3V5cMf2%2BbaXCPyuCQiI5OZ%2FETpk3fSN%2BaX%2BahlZelukUyjHY6Ay3h0WHULaZOavgx2n6dd4ZNBmGQE3TBh2APDhcdkVL5klO%2Bxf3q7m2Xi2%2F9KXar9k0Ei%2FSlXBiw4bde9OUK5SlZm8SkyW%2FuMfYyKZwWY2LC%2Bf0qirMdyuJ2y6gpUzr1BAdyTOWQU7XkGag%3D%3D"}}
/v1/order/buyList?access_token=xxxxx
application/json
GET/POST
参数 必选 类型 说明 RequestBody page 否 int 页数,默认1 pageSize 否 int 页码,默认20 order 否 String 排序:orderId desc q 否 String 关键字搜索 orderType 否 int 订单类型:normal(普通),speech(语音识别),course(课程),swl(课时),knowledge(知识点),live(直播) payStatus 否 int 支付状态: 1.下单成功(未支付) 2.已支付 startTime 否 String 开始时间 endTime 否 String 结束时间
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 返回状态码 |
message | String | 返回错误信息 |
data | Array | 返回结果 |
Request
{"status":200,"data":{"total_page":1,"page":"1","pagesize":"20","total_record":1,"record":[{"orderId":"15","orderName":"\u7535\u529b\u7cfb\u7edf\u9884\u6d4b\u8bfe\u7a0b","outTradeNo":"1398036302201710181459265747","orderNo":"1398036302201710181459265747","orderType":"course","payMode":"WXPAY","totalFee":"0.01","payStatus":"2","tradeType":"NATIVE","product_id":null,"payDate":"2017-10-18 14:59:26","businessUserId":"1011","business":"\u4e01\u7ea2\u8273","creationDate":"2017-10-18 14:59:26"}]}}
/v1/order/list?access_token=xxxxx
application/json
GET/POST
参数 必选 类型 说明 RequestBody page 否 int 页数,默认1 pageSize 否 int 页码,默认20 order 否 String 排序:orderId desc q 否 String 关键字搜索 orderType 否 int 订单类型:normal(普通),speech(语音识别),course(课程),swl(课时),knowledge(知识点),live(直播) payStatus 否 int 支付状态: 1.下单成功(未支付) 2.已支付 startTime 否 String 开始时间 endTime 否 String 结束时间
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 返回状态码 |
message | String | 返回错误信息 |
data | Array | 返回结果 |
Request
{"status":200,"data":{"total_page":1,"page":"1","pagesize":"20","total_record":1,"total_amount":"0.01","record":[{"orderId":"15","orderName":"\u7535\u529b\u7cfb\u7edf\u9884\u6d4b\u8bfe\u7a0b","outTradeNo":"1398036302201710181459265747","orderNo":"1398036302201710181459265747","orderType":"course","payMode":"WXPAY","totalFee":"0.01","payStatus":"2","tradeType":"NATIVE","userId":"628","productId":null,"payDate":"2017-10-18 14:59:26","businessUserId":"761","business":"\u4e01\u7ea2\u8273","creationDate":"2017-10-18 14:59:26","username":"44442","nickName":"44442"}]}}
/v1/order/info?access_token=xxxxx
application/json
GET/POST
参数 必选 类型 说明 RequestBody orderId 否 String 订单号 productId 否 String 商品id q 否 String 关键字搜索 orderType 否 int 订单类型:normal(普通),speech(语音识别),course(课程),swl(课时),knowledge(知识点),live(直播) payStatus 否 int 支付状态: 1.下单成功(未支付) 2.已支付 startTime 否 String 开始时间 endTime 否 String 结束时间
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 返回状态码 |
message | String | 返回错误信息 |
data | Array | 返回结果 |
Request
{"status":200,"data":{"orderId":"16","orderName":"\u7535\u529b\u7cfb\u7edf\u9884\u6d4b\u8bfe\u7a0b","outTradeNo":"1398036302201710181744315652","orderNo":"1398036302201710181744315652","orderType":"course","payMode":"WXPAY","totalFee":"0.01","payStatus":"1","tradeType":"NATIVE","productId":"79080a09-5147-417d-b0b6-23a8cddf29dc","payDate":null,"businessUserId":"1011","business":"\u4e01\u7ea2\u8273","creationDate":"2017-10-18 17:44:31"}}
/v1/order/export/{type}?access_token=xxxxx
application/json
GET/POST
参数 必选 类型 说明 RequestBody type 是 string 导出业务: 收入orderList、支出buyList order 否 String 排序:orderId desc q 否 String 关键字搜索 orderType 否 int 订单类型:normal(普通),speech(语音识别),course(课程),swl(课时),knowledge(知识点),live(直播) payStatus 否 int 支付状态: 1.下单成功(未支付) 2.已支付 startTime 否 String 开始时间 endTime 否 String 结束时间
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 返回状态码 |
message | String | 返回错误信息 |
data | Array | 返回结果 |
Request
{"status":200,"data":{"total_page":1,"page":"1","pagesize":"20","total_record":1,"total_amount":"0.01","record":[{"orderId":"15","orderName":"\u7535\u529b\u7cfb\u7edf\u9884\u6d4b\u8bfe\u7a0b","outTradeNo":"1398036302201710181459265747","orderNo":"1398036302201710181459265747","orderType":"course","payMode":"WXPAY","totalFee":"0.01","payStatus":"2","tradeType":"NATIVE","userId":"628","productId":null,"payDate":"2017-10-18 14:59:26","businessUserId":"761","business":"\u4e01\u7ea2\u8273","creationDate":"2017-10-18 14:59:26","username":"44442","nickName":"44442"}]}}
/v1/order/boughtList?access_token=xxxxx
application/json
GET/POST
参数 必选 类型 说明 RequestBody orderType 是 int 订单类型:normal(普通),speech(语音识别),course(课程),swl(课时),knowledge(知识点),live(直播) payStatus 是 int 支付状态: 1.下单成功(未支付) 2.已支付 startTime 否 String 开始时间 endTime 否 String 结束时间
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 返回状态码 |
message | String | 返回错误信息 |
data | Array | 返回结果 |
Request
{"status":200,"data":{"79080a09-5147-417d-b0b6-23a8cddf29dc":{"payStatus":"2"},"79080a09-5147-417d-b0b6-23a8cddf2133":{"payStatus":"2"}}}
/v1/appstore/InAppProductList
application/json
GET/POST
参数 必选 类型 说明 RequestBody access_token 是 string 用户access_token
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 状态码 |
data | array | 当前提交的内容 |
返回示例
{"status":200,"data":[{"id":"1","productId":"com.sewise.weilubo.KnowledgeYuan2","referenceName":"1\u5143=0.7\u77e5\u8bc6\u5e01","actualObtain":"0.70","originalObtain":"1.00","creationDate":"2018-04-13 11:33:20"},{"id":"2","productId":"com.sewise.weilubo.KnowledgeYuan3","referenceName":"6\u5143=4.2\u77e5\u8bc6\u5e01","actualObtain":"4.20","originalObtain":"6.00","creationDate":"2018-04-13 11:33:20"},{"id":"3","productId":"com.sewise.weilubo.KnowledgeYuan4","referenceName":"18\u5143=12.6\u77e5\u8bc6\u5e01","actualObtain":"12.60","originalObtain":"18.00","creationDate":"2018-04-13 11:33:20"},{"id":"4","productId":"com.sewise.weilubo.KnowledgeYuan5","referenceName":"40\u5143=28\u77e5\u8bc6\u5e01","actualObtain":"28.00","originalObtain":"40.00","creationDate":"2018-04-13 11:33:20"},{"id":"5","productId":"com.sewise.weilubo.KnowledgeYuan6","referenceName":"108\u5143=75.6\u77e5\u8bc6\u5e01","actualObtain":"75.60","originalObtain":"108.00","creationDate":"2018-04-13 11:33:20"},{"id":"6","productId":"com.sewise.weilubo.KnowledgeYuan7","referenceName":"518\u5143=362.6\u77e5\u8bc6\u5e01","actualObtain":"362.60","originalObtain":"518.00","creationDate":"2018-04-13 11:33:20"}]}
/v1/appstore/validateApplePay
application/json
POST
参数 必选 类型 说明 RequestBody access_token 是 string 用户access_token receiptData 是 string appstore支付收据串
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 状态码 |
data | array | 当前提交的内容 |
返回示例
{"status":200,"message":"\u8d2d\u4e70\u6210\u529f","data":{"status":0,"environment":"Sandbox","sandbox":"1","recharge_amount":28}}
/v1/wallet/my
application/json
POST/GET
参数 必选 类型 说明 RequestBody access_token 是 string 用户access_token
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 状态码 |
data | array | 当前提交的内容 |
返回示例
{"status":200,"data":{"awId":"1","userId":"5","type":"1","status":"1","freezingAmount":"0.00","activeAmount":"55.97","password":true,"creationDate":"2018-04-16 15:37:29","modifiedDate":"2018-04-17 14:59:30"}}
/v1/wallet/resetPass
application/json
POST
参数 必选 类型 说明 RequestBody access_token 是 string 用户access_token password 是 string 密码
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 状态码 |
data | array | 当前提交的内容 |
返回示例
{"status":200,"message":"\u5bc6\u7801\u91cd\u7f6e\u6210\u529f"}
/v1/wallet/pay
application/json
POST
参数 必选 类型 说明 RequestBody access_token 是 String 用户授权签名 password 是 String 支付密码 orderName 是 String 订单/商品描述 orderType 是 String 订单类型:normal(普通),speech(语音识别),course(课程),swl(课时),knowledge(知识点),live(直播) tradeType 否 String 交易类型:(JSAPI,NATIVE,WAP, APP等) totalFee 是 decimal 订单金额(元) deviceInfo 否 String 设备信息 productId 否 String 商品id(如course_id) ip 否 String 终端IP businessUserId 否 String 商家标识,如openid、userId business 否 String 商家名称
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 返回状态码 |
message | String | 返回错误信息 |
data | Array | 返回结果 |
Request
curl -X POST -H "Content-Type:application/json" -d http://api.sewise.com/v1/wallet/pay?access_token=xxx
Response
{"status":200,"message":"\u4e0b\u5355\u6210\u529f\uff0c\u5df2\u652f\u4ed8"}