《第三方充值平台接口开发文档》由会员分享，可在线阅读，更多相关《第三方充值平台接口开发文档（20页珍藏版）》请在金锄头文库上搜索。
1、深圳市创盾网络科技有限公司APIAPI 接口说明书接口说明书版本3.02.01.11.0参数注释验证服务器 ip创建文档更新内容签名生成方式2013.11.122013.07.242013.02.082012.12.21时间1 1 / 2020深圳市创盾网络科技有限公司目录目录1、API 介绍 . 31.1 通讯协议.31.2 充值流程.31.3 权限版本 （power） .31.4 版本号 （ver） .41.5 时间戳 （timestamp） .41.6 订单号 （orderid）.41.7 数字签名（sign 和 signkey） .42、API 调用说明 . 52.1 在线充值.52.
2、2 订单回调.72.3 商品进价表.72.4 渠道商信息.92.5 游戏区服表.112.6 用户余额.122.7 手机号码归属地.122.8 系统时间戳.132.9 销售软件.132.10 激活码开通软件.142.11 下级用户列表.152.12 财务记录.162.13 订单记录.172.14 转账 .193、注意事项. 194、通用状态码.205、附录 .205.1 全国省份直辖市 ID 对照表 .202 2 / 2020深圳市创盾网络科技有限公司1 1、APIAPI 介绍介绍1.11.1 通讯协议通讯协议1. 联系速度达技术（QQ：1551369420）获取密钥 KEY，及接口地址。2.
3、接口采用 GET/POST方式提交请求3. 返回 XML 或 JSON，传入参数增加 format=xml或者 format=json1.21.2 充值流程充值流程一次请求保存在本地1 1请求时间戳请求时间戳系统启动，获取服务器时间戳 api/sys_now2 2请求产品表、渠道表、区服表请求产品表、渠道表、区服表获取充值产品表 api/product、渠道表api/product_channel、区服表 api/product_area(该步骤执行一次存储在本地即可)3 3选择产品选择产品根据所要充值的业务需要先调用本地数据(游戏充值需调用区服表、手机充值需调用渠道表并请求归属地 api/s
4、ys_phone)，然后选择产品。4 4提交订单提交订单多次请求将充值订单提交到充值接口 api/recharge。其中productid就是api/product的 i ； area的值就是手机号码归属地对应的值（见附录）如果是游戏则是api/product_area的i。5 5回调订单状态回调订单状态回调订单状态 api/status。1.31.3 权限版本权限版本 （powerpower）13 代表普及版15 代表专业版3 3 / 2020深圳市创盾网络科技有限公司16 代表豪华版17 代表旗舰版1.41.4 版本号版本号 （verver）固定值等于 3，每个 api 接口必须要传的参数
5、。1.51.5 时间戳时间戳 （timestamptimestamp）时间戳是自 1970 年 1 月 1 日（00:00:00 GMT）至当前时间的总秒数。时间戳的有效期为 10 分钟。如果您的本机时间为准确的 “北京时间” ，可使用本机时间戳， 否则可通过接口获取当前服务器的时间戳， 以它为基本，开始自动计时。时间戳是很多接口必须要传的一个参数。时间戳的目的是为了使一个接口产生的URL 在 10 分钟后失效，提高安全性。1.61.6 订单号订单号 （orderidorderid）为防止重复提交，很多接口都必须传入订单号。建议按如下方法生成：取系统当前时间按年月日小时分钟秒毫秒，再与用户编号
6、用字母“v”相连。生成如：20131112170125156v1234561.71.7 数字签名（数字签名（signsign 和和 signkeysignkey）sign以时间戳作为秘钥signkey以 KEY 值和时间戳作为秘钥如下请求为例，来说明 signkey 生成步骤http:/* key 进行字典升序排列，将接口名和排序后的参数(key=value)用&拼接起来。例如：/api/recharge?count=1&orderid=1384243215449v9631&productid=1139×tamp=1384243215&to=13800138000&username=
7、&ver=3&将上面生成的字符串连上用户设置的秘钥进行 URLencode 转码，把转码后的字符串进行 MD5 加密，即是 signkey。signkey=md5(URLencode(/api/recharge?count=1&orderid=1384243215449v9631&productid=1139×tamp=1384243215&to=13800138000&username=&ver=3&用户秘钥)sign则是以/api/recharge?count=1&orderid=1384243215449v9631&productid=1139×tamp=138424
8、3215&t4 4 / 2020深圳市创盾网络科技有限公司o=13800138000&username=&ver=3 进行进行 URLencode 转码，把转码后的字符串进行 MD5 加密。sign=md5(URLencode(/api/recharge?count=1&orderid=1384243215449v9631&productid=1139×tamp=1384243215&to=13800138000&username=&ver=3)2 2、APIAPI 调用说明调用说明2.12.1 在线充值在线充值http:/* ID充值对象地区 ID/区服 ID（手机充值详见附录 1
9、）购买数量（件数）用户的真实 IP时间戳接口版本号签名串(不参与加密)是否必填YYYYNNYNYYY返回参数说明：返回参数说明：参数名称balancestatustips数据类型floatintString说明用户余额-1 表示余额未变化状态详见“通用状态码”状态提示信息请求示例http:/*http:/* 69.4669.46充值后用户所剩余额1 1状态码：0(0(状态已更新！状态已更新！) )提示响应示例5 5 / 2020深圳市创盾网络科技有限公司使用下表商品使用下表商品 IDID 充值话费，充值话费，areaarea 值可传值可传 0 0（无需判断号码归属地）。（无需判断号码归属地）。
10、中国移动（全国）1 元2 元3 元4 元5 元6 元7 元8 元9 元商品 ID1836937037124372373374375中国联通（全国）1 元2 元3 元4 元5 元6 元7 元8 元9 元商品 ID108910901091109210931094109510961097中国电信（全国）10 元20 元30 元50 元100 元商品 ID15821583113011311132全国固话（全国）10 元20 元30 元50 元100 元商品 ID169916981700170117026 6 / 2020深圳市创盾网络科技有限公司2.22.2订单回调订单回调(建议下单成功1分钟后调用)
11、http:/* 表示余额未变化状态详见“通用状态码”状态提示信息请求示例http:/* 69.4669.46充值后用户所剩余额-1 表示余额未变1 1状态码：0(0(状态已更新！状态已更新！) )提示响应示例2.32.3 商品进价表商品进价表http:/* 时返回加密后的 GZIP 串接口版本号签名串(不参与加密)YNYY返回参数说明：返回参数说明：7 7 / 2020深圳市创盾网络科技有限公司参数名称veribfut数据类型intintStringfloatStringint说明商品进价表版本号产品 ID 充值时传给服务器产品名称面值单位小分类移动是 100，联通是 101，电信是 102，
12、固话是 103QQ 业务是 200，Q 币 Q 点是 201游戏是大等于 300cvqsomintintintintintString渠道 ID省份 ID详见“全国省份直辖市 ID 对照表”商品大类话费业务是 1，QQ 业务是 2，游戏业务是 3库存大于 0 均表示库存充足排序限购数量如：1-1目前话费业务不支持倍充p16statustipsfloatintString豪华版进价旗舰版是 p17状态详见“通用状态码”状态提示信息请求示例http:/* 3030版本号13491349产品 ID，充值时传给服务端浙江电信浙江电信( (手机手机) )产品名称5050面值元元单位102102小分类，移
13、动是 100,联通是 101,电信是 102，固话是 1031111渠道 ID3333省份1 11 表示手机，2 表示 QQ 业务，3 是游戏。8 8 / 2020响应示例深圳市创盾网络科技有限公司9999库存2 2排序，值越小越靠前1 11 1提交件数限止49.349.349.349.3普及版充值报价49.349.349.349.3专业版充值报价49.349.3豪华版充值报价49.349.3340340湖北联通湖北联通( (手机手机) )100100元元101101121242421 199993 31 11 198.698.698.698.698.698.698.698.698.698.6
14、98.698.61 1状态码2.42.4渠道商信息渠道商信息http:/* 9 / 2020深圳市创盾网络科技有限公司timestampgzipversignlongVarchar2(10)intVarchar2(32)时间戳gzip=true 时返回加密后的 GZIP 串接口版本号签名串(不参与加密)YNYY返回参数说明：返回参数说明：参数名称icrstatustips数据类型intStringStringintString说明渠道商 ID对应产品进价表的 c渠道名称备注状态详见“通用状态码”状态提示信息请求示例http:/* 1渠道 ID。对应 product 中的 C腾讯腾讯渠道名称备注
15、响应示例（数据返回量大，为避免本文档冗余，有删节）203203网易网易获取成功！获取成功！提示1 1状态码1010 / 2020深圳市创盾网络科技有限公司2.52.5游戏区服表游戏区服表http:/* 时返回加密后的 GZIP 串用户名时间戳接口版本号签名串(不参与加密)是否必填NYYYY返回参数说明：返回参数说明：参数名称itvstatustips数据类型intStringStringintString说明产品 ID对应产品进价表的 i游戏区服名称游戏区服值充值接口的 area状态详见“通用状态码”状态提示信息请求示例http:/* ID。对应 product 中的 i华夏电信华夏电信 78
16、78 区区名称556556area ID（数据返回量大，为避免本文档冗余，有删节）响应示例 15311531网通一区网通一区 黎明港湾黎明港湾191519151111 / 2020深圳市创盾网络科技有限公司获取成功！获取成功！提示1 1状态码2.62.6 用户余额用户余额http:/* 50.050.0用户余额0.00.0未确认余额豪华版豪华版用户类型获取成功！获取成功！提示1 1状态码响应示例2.72.7 手机号码归属地手机号码归属地http:/* / 2020深圳市创盾网络科技有限公司signVarchar2(32)签名串(不参与加密)Y返回参数说明：返回参数说明：参数名称typecity
17、areacodezipcodestatustips数据类型StringStringStringStringintString说明号码运营商归属地区号邮编状态详见“通用状态码”状态提示信息请求示例http:/* GSMGSM号码运营商北京北京 北京北京归属地010010区号100000100000邮编获取成功！获取成功！提示1 1状态码响应示例2.82.8 系统时间戳系统时间戳http:/* 1387437191系统时间戳获取成功！获取成功！提示1 1状态码2.92.9 销售软件销售软件http:/* / 2020深圳市创盾网络科技有限公司orderidopenpowertimestampver
18、signkeyVarchar(50)Varchar(50)intlongintVarchar2(32)订单号要开通用户名权限版本号时间戳接口版本号签名串(不参与加密)YYYYYY返回参数说明：返回参数说明：参数名称incomebalancestatustips数据类型floatfloatintString说明此次扣费金额用户余额状态详见“通用状态码”状态提示信息请求示例http:/* in-270-270此次扣费金额69.4669.46用户余额1 1状态码开通成功！提示响应示例2.102.10 激活码开通软件激活码开通软件http:/* / 2020深圳市创盾网络科技有限公司tipsStrin
19、g状态提示信息请求示例http:/* 普及版开通版本响应示例激活成功！提示1状态码2.112.11下级用户列表下级用户列表http:/* 2013-11-01结束时间 2013-11-22下级速度达账号第几页每页几行 默认 25 行时间戳接口版本号签名串(不参与加密)是否必填YYYNNNYYY返回参数说明：返回参数说明：参数名称usernametimepowerpower_textstatustips数据类型StringStringintStringintString说明开通的用户名开通时间开通的版本开通版本名称状态详见“通用状态码”状态提示信息请求示例http:/* / 2020响应示例深圳
20、市创盾网络科技有限公司2013-11-12 16:47:5313普及版1共几页1总行数获取成功！12.122.12 财务记录财务记录http:/* 2013-11-01结束时间 2013-11-22订单编号/交易对方账号/加款账号第几页每页几行 默认 25 行时间戳接口版本号签名串(不参与加密)是否必填YYYYNNNYYY返回参数说明：返回参数说明：参数名称oibtrstatustips数据类型StringfloatfloatStringStringintString说明财务流水号收/支余额交易时间交易备注状态详见“通用状态码”状态提示信息请求示例http:/* / 2020深圳市创盾网络科技
21、有限公司085221f720b5b5d2f8b085221f720b5b5d2f8b响应示例138502484370012329878.029878.02013-11-21 17:08来自的转账(士大夫)20131121170706215v9631财务流水号-29878.5收/支0.1余额2013-11-21 17:07交易时间转账至备注4共几页37总行数获取成功！12.132.13订单记录订单记录http:/* 2013-11-01结束时间 2013-11-22订单编号/充值号码第几页每页几行 默认 25 行时间戳接口版本号签名串(不参与加密)是否必填YYYYNNNYYY返回参数说明：返回参
22、数说明：参数名称oe数据类型StringString说明订单编号备注1717 / 2020深圳市创盾网络科技有限公司pbas_texttt_okcsyfstatustipsfloatStringStringStringStringStringStringStringStringStringintString价格充值号码买家状态描述下单时间订单成功时间渠道客户端业务类型数量状态详见“通用状态码”状态提示信息请求示例http:/* 14:49下单时间2013-12-18 14:49订单成功时间腾讯渠道电脑网页QQ业务业务类型1.0个1件1.0个数量4共几页37总行数获取成功！11818 / 202
23、0响应示例深圳市创盾网络科技有限公司2.142.14转账转账http:/* 69.4669.46用户余额1 1状态码开通成功！提示响应示例3 3、注意事项、注意事项1.2.系统对同一IP的充值请求频次限制在30秒90次。如果商户的交易量超过该频次限制的话，切记不要把系统对提交的充值请求只进行单次处理，如果交易过程出现错误，该笔交易被视为无效请求，系统不交易请求通过同一IP发送。会再继续处理该交易请求（如已对商户进行扣款的，系统会自动在当日或次日进行退款） 。商户需根据自己的实际情况确定是否再次发起充值请求。3.4.5.6.如部分订单未及时退款的，请商户联系我们的在线客服查单退款。本系统所有参数
24、及MD5加密串均为小写。因速度达 API 接口基于 Linux+Java 架构，所以 URL 区分大小写。所有请求接口都需传入 username 参数URLEncode 转码注意各语言的差异，本系统采用的是 .URLEncode.encode()，相对应的 c#用Uri.EscapeDataString()。7.1919 / 2020深圳市创盾网络科技有限公司4 4、通用状态码、通用状态码状态码-9-1105910说明订单未提交，未扣款（提示各种异常）已扣款，将提交供货商成功处理中疑似成功部分退款全额退款5 5、附录、附录5.15.1 全国省份直辖市全国省份直辖市 IDID 对照表对照表ID0111213141521222331323334353637全国北京天津河北山西内蒙古辽宁吉林黑龙江上海江苏浙江安徽福建江西山东text41424344454650515253546162636465ID河南湖北湖南广东广西海南重庆四川贵州云南西藏陕西甘肃青海宁夏新疆text2020 / 2020
