RD_计费网关服务端接口规格说明_06_详细设计_ver.1.1.5
相关主题
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
计费网关接口详细设计说明书
日期 2010/7/1 2010/7/12 2010/7/22
2010/7/26 2010/8/17
版本 1.1.1 1.1.2 1.1.3
1.1.4 1.1.5
作者 高波 高波 陶然
陶然 高波
备注 建立 修改附件支付密码示例 去掉 sessionId; needPassword 的值改为 bool 类型 增加 externalIdType 增 加 附 件 中 ResultCode; 增 加 查 询协议接口;修改支付密码示例； 修改添加产品包、查询余额资源 地址;
响应参数 参数名称
resultCode resultMesg
参数含义 消息结果 错误消息
参数长度
参数说明
Max(3) Max(50)
-1：未知错误 0：成功 >0：失败 参照附件：ResultCode 表
例：维护升级
reservedVolumes 预留数量
currency
货币单位
reservedLeft
1） ReservationBusiness 接口(先预留，后扣费).................................................................. 2 POST Method.................................................................................................................... 4 PUT Method...................................................................................................................... 6 DELETE Method...............................................................................................................7
PUT Method
PUT 方法用于追加预留数额或扣除之前已经预留的部分或全部金额。除视频通话的实时计 费业务外，一般应用很少会使用此消息。
请求地址：/gateway/services/reservations/{appId}/{appSerialNo}
请求参数 参数名称
参数含义
参数长度
参数说明
appId
消费货币数量
整型部分最长14位，小数位最长8位
CNY百度文库人民币
pointOrigin
请求源地址
Max(72) 目前为空
pointTarget sign
请求目标地址 签名
Max(72) 32
目前为空
签名数据格式：例 sign = MD5(appSerialNo&huanId&token&……&K EY)
Max(10) 1 1 1
Max(23) Max(23)
3
失败重传时的消息标识
1：Unit 2：Amount 1：CREDIT 2：DEBIT 1: RESERVE (预留) 2: CONSUME (扣除之前的预留额) 消费或预留数量
累积预留数量
sessionTimeLeft 会话时间
needPassword redirectUrl
是否需要输入 支付密码
支付密码页面 地址
sign
签名
Max(23) 3
Max(23) Max(20)
N/A Max(200)
32
此消息成功预留的数量
整型部分最长 14 位，小数位最长 8 位
货币单位，例：CNY
5. 附件............................................................................................................................................ 14 1）支付密码........................................................................................................................... 14 2）ResultCode 表................................................................................................................... 16
目录
1. 文档对象...................................................................................................................................... 2 2. 文档目的...................................................................................................................................... 2 3. 计费接口...................................................................................................................................... 2
参数说明
version
协议版本
协议版本
appSerialNo
应用流水号
Max(20) 由应用生成和维护
externalId externalIdType token chargeType operationType appId
external-Id externalId 类
型 身份认证 业务类型
操作类型
4. 帐户及产品管理接口................................................................................................................ 11 1）Accounts 接口................................................................................................................... 11 POST Method (添加帐户).............................................................................................. 11 POST Method (添加产品包)...........................................................................................11 GET Method (查询帐户余额)........................................................................................ 12 PUT Method (修改帐户密码).........................................................................................13 PUT Method (重置帐户密码).........................................................................................13 GET Method (查询协议)................................................................................................ 14
无需输入支付密码：
需输入支付密码：
POST Method
POST 方法是应用向计费中心发起的预留类型请求的第一条消息。计费中心在收到此消息后 会创建计费会话，并为应用服务预留一定数额的资金。
请求地址：/gateway/services/reservations/ 请求参数
参数名称
参数含义
参数长度
unitType
消息类型
Max(6) 消费数量的单位类型
transactionTime
交易时间
consumptionUnits 消费单位数量
consumptionAmoun 消费货币数量
t
currency
货币单位
14 Max(23) Max(23)
3
格式：yyyyMMddHHmmss
消费单位数量
整型部分最长14位，小数位最长8位
消息类型
Max(10) 计费中心分发给每个应用的唯一 ID
appSerialNo
应用流水号
Max(20) 由应用生成和维护
referenceNo chargeType operationType updateMode units amount currency
序号 业务类型 操作类型 更新类型 消费单位数量 消费货币数量 货币类型
消息类型
Max(20) 用户 Id
Max(6) 用户 ID 类型
32 1 1 Max(10)
用户中心 TOKEN
1：Unit 2：Amount 1：CREDIT 2：DEBIT 3：REFUND(内部系统使用)
计费中心分发给每个应用的唯一 ID
subTypeId
消息类型
Max(10) 计费中心分发给应用的子类型 ID
1. 文档对象
计费网关设计人员、开发人员、产品经理、应用服务开发人员。
2. 文档目的
描述计费网关的接口详细设计方案。 接口采用 http 方式进行连接，数据格式采用 JSON；内部接口只对内部系统开放，外部 接口对所有终端开放。 请求格式：例 { appSerialNo:"12345678" huanId:"010123445"; token:"876098"; …… } 响应格式 { sessionId:"12345678" resultCode:"3"; resultMesg:"尚未开通收费服务"; …… }
3. 计费接口
1）ReservationBusiness 接口(先预留，后扣费)
计费中心提供的“先预留，后扣费”类型（简称预留类型）服务，可以保证应用在成功 向用户交付完服务之后再扣除用户帐户中的金额。避免预先扣费，却交付服务失败而引起的 用户纠纷。
对 于预 留类 型的 请求 ，计 费系 统在 收到 预留 请求 后会 为其 创建 一个 计费 会话 （ rating session）并冻结用户账户中一定数额的欢币或人民币，直到应用向计费中心发出“结束”（扣 除之前预留的金额）或“释放”（将之前预留的金额退还到用户帐户中）消息，或者当计费 会话的生命周期超过有效期后系统根据业务规则自动“结束”或“释放”预留的金额。
2） BalanceBusiness 接口（直接扣费）............................................................................... 8 POST Method.................................................................................................................... 9
当前会话累积预留数量
整型部分最长 14 位，小数位最长 8 位
当前会话剩余有效时间，以秒为单位
true：需要 false：不需要 needPassword=1 需在 redirectUrl 后添加回 调地址 签名数据格式：例 sign = MD5(sessionId&resultCode&……&KEY)
日期 2010/7/1 2010/7/12 2010/7/22
2010/7/26 2010/8/17
版本 1.1.1 1.1.2 1.1.3
1.1.4 1.1.5
作者 高波 高波 陶然
陶然 高波
备注 建立 修改附件支付密码示例 去掉 sessionId; needPassword 的值改为 bool 类型 增加 externalIdType 增 加 附 件 中 ResultCode; 增 加 查 询协议接口;修改支付密码示例； 修改添加产品包、查询余额资源 地址;
响应参数 参数名称
resultCode resultMesg
参数含义 消息结果 错误消息
参数长度
参数说明
Max(3) Max(50)
-1：未知错误 0：成功 >0：失败 参照附件：ResultCode 表
例：维护升级
reservedVolumes 预留数量
currency
货币单位
reservedLeft
1） ReservationBusiness 接口(先预留，后扣费).................................................................. 2 POST Method.................................................................................................................... 4 PUT Method...................................................................................................................... 6 DELETE Method...............................................................................................................7
PUT Method
PUT 方法用于追加预留数额或扣除之前已经预留的部分或全部金额。除视频通话的实时计 费业务外，一般应用很少会使用此消息。
请求地址：/gateway/services/reservations/{appId}/{appSerialNo}
请求参数 参数名称
参数含义
参数长度
参数说明
appId
消费货币数量
整型部分最长14位，小数位最长8位
CNY百度文库人民币
pointOrigin
请求源地址
Max(72) 目前为空
pointTarget sign
请求目标地址 签名
Max(72) 32
目前为空
签名数据格式：例 sign = MD5(appSerialNo&huanId&token&……&K EY)
Max(10) 1 1 1
Max(23) Max(23)
3
失败重传时的消息标识
1：Unit 2：Amount 1：CREDIT 2：DEBIT 1: RESERVE (预留) 2: CONSUME (扣除之前的预留额) 消费或预留数量
累积预留数量
sessionTimeLeft 会话时间
needPassword redirectUrl
是否需要输入 支付密码
支付密码页面 地址
sign
签名
Max(23) 3
Max(23) Max(20)
N/A Max(200)
32
此消息成功预留的数量
整型部分最长 14 位，小数位最长 8 位
货币单位，例：CNY
5. 附件............................................................................................................................................ 14 1）支付密码........................................................................................................................... 14 2）ResultCode 表................................................................................................................... 16
目录
1. 文档对象...................................................................................................................................... 2 2. 文档目的...................................................................................................................................... 2 3. 计费接口...................................................................................................................................... 2
参数说明
version
协议版本
协议版本
appSerialNo
应用流水号
Max(20) 由应用生成和维护
externalId externalIdType token chargeType operationType appId
external-Id externalId 类
型 身份认证 业务类型
操作类型
4. 帐户及产品管理接口................................................................................................................ 11 1）Accounts 接口................................................................................................................... 11 POST Method (添加帐户).............................................................................................. 11 POST Method (添加产品包)...........................................................................................11 GET Method (查询帐户余额)........................................................................................ 12 PUT Method (修改帐户密码).........................................................................................13 PUT Method (重置帐户密码).........................................................................................13 GET Method (查询协议)................................................................................................ 14
无需输入支付密码：
需输入支付密码：
POST Method
POST 方法是应用向计费中心发起的预留类型请求的第一条消息。计费中心在收到此消息后 会创建计费会话，并为应用服务预留一定数额的资金。
请求地址：/gateway/services/reservations/ 请求参数
参数名称
参数含义
参数长度
unitType
消息类型
Max(6) 消费数量的单位类型
transactionTime
交易时间
consumptionUnits 消费单位数量
consumptionAmoun 消费货币数量
t
currency
货币单位
14 Max(23) Max(23)
3
格式：yyyyMMddHHmmss
消费单位数量
整型部分最长14位，小数位最长8位
消息类型
Max(10) 计费中心分发给每个应用的唯一 ID
appSerialNo
应用流水号
Max(20) 由应用生成和维护
referenceNo chargeType operationType updateMode units amount currency
序号 业务类型 操作类型 更新类型 消费单位数量 消费货币数量 货币类型
消息类型
Max(20) 用户 Id
Max(6) 用户 ID 类型
32 1 1 Max(10)
用户中心 TOKEN
1：Unit 2：Amount 1：CREDIT 2：DEBIT 3：REFUND(内部系统使用)
计费中心分发给每个应用的唯一 ID
subTypeId
消息类型
Max(10) 计费中心分发给应用的子类型 ID
1. 文档对象
计费网关设计人员、开发人员、产品经理、应用服务开发人员。
2. 文档目的
描述计费网关的接口详细设计方案。 接口采用 http 方式进行连接，数据格式采用 JSON；内部接口只对内部系统开放，外部 接口对所有终端开放。 请求格式：例 { appSerialNo:"12345678" huanId:"010123445"; token:"876098"; …… } 响应格式 { sessionId:"12345678" resultCode:"3"; resultMesg:"尚未开通收费服务"; …… }
3. 计费接口
1）ReservationBusiness 接口(先预留，后扣费)
计费中心提供的“先预留，后扣费”类型（简称预留类型）服务，可以保证应用在成功 向用户交付完服务之后再扣除用户帐户中的金额。避免预先扣费，却交付服务失败而引起的 用户纠纷。
对 于预 留类 型的 请求 ，计 费系 统在 收到 预留 请求 后会 为其 创建 一个 计费 会话 （ rating session）并冻结用户账户中一定数额的欢币或人民币，直到应用向计费中心发出“结束”（扣 除之前预留的金额）或“释放”（将之前预留的金额退还到用户帐户中）消息，或者当计费 会话的生命周期超过有效期后系统根据业务规则自动“结束”或“释放”预留的金额。
2） BalanceBusiness 接口（直接扣费）............................................................................... 8 POST Method.................................................................................................................... 9
当前会话累积预留数量
整型部分最长 14 位，小数位最长 8 位
当前会话剩余有效时间，以秒为单位
true：需要 false：不需要 needPassword=1 需在 redirectUrl 后添加回 调地址 签名数据格式：例 sign = MD5(sessionId&resultCode&……&KEY)