logo资料库

接口设计文档示例.pdf

第1页 / 共14页
第2页 / 共14页
第3页 / 共14页
第4页 / 共14页
第5页 / 共14页
第6页 / 共14页
第7页 / 共14页
第8页 / 共14页
资料共14页,剩余部分请下载后查看
1 文档说明
1.1 功能描述
1.2 阅读对象
1.3 业务术语
2 功能演示
3 数据交互
4 请求参数说明
4.1 含义
4.2 列表
4.3 样例
5 xml同步返回参数说明
5.1 含义
5.2 列表
5.3 样例
6 通知返回数据处理
6.1 xml同步返回特性
6.2 商户业务处理注意事项
7 签名机制
7.1 生成待签名的字符串
7.1.1 需要参与签名的参数
7.1.2 生成待签名字符串
7.2 签名
7.2.1 MD5签名
7.2.2 DSA、RSA签名
8 附录
8.1 集分宝兑换业务错误码
8.2 系统错误码
集分宝兑换接口 服务名称:generalpoint_add_point 版本号:1.5 支付宝(中国)网络技术有限公司 版权所有
集分宝兑换接口 目 录 1 文档说明 .............................................................................................................. 4  1.1 功能描述 ............................................................................................................................... 4  1.2 阅读对象 ............................................................................................................................... 4  1.3 业务术语 ............................................................................................................................... 4  2 功能演示 .............................................................................................................. 5  3 数据交互 .............................................................................................................. 5  4 请求参数说明 ....................................................................................................... 6  4.1 含义 ...................................................................................................................................... 6  4.2 列表 ...................................................................................................................................... 6  4.3 样例 ...................................................................................................................................... 8  5 xml同步返回参数说明 .......................................................................................... 9  5.1 含义 ...................................................................................................................................... 9  5.2 列表 ...................................................................................................................................... 9  5.3 样例 .................................................................................................................................... 10  6 通知返回数据处理 .............................................................................................. 10  6.1 xml同步返回特性 ................................................................................................................. 10  6.2 商户业务处理注意事项 ....................................................................................................... 11  支付宝(中国)网络技术有限公司 版权所有| 版本:1.5 第 2 页
集分宝兑换接口 7 签名机制 ............................................................................................................ 11  7.1 生成待签名的字符串 ........................................................................................................... 11  7.1.1 需要参与签名的参数 ................................................................................................ 11  7.1.2 生成待签名字符串 .................................................................................................... 11  7.2 签名 .................................................................................................................................... 12  7.2.1 MD5 签名 .................................................................................................................. 12  7.2.2 DSA、RSA签名 ........................................................................................................ 12  8 附录 ................................................................................................................... 13  8.1 集分宝兑换业务错误码 ....................................................................................................... 13  8.2 系统错误码 ......................................................................................................................... 14  支付宝(中国)网络技术有限公司 版权所有| 版本:1.5 第 3 页
集分宝兑换接口 1 文档说明 1.1 功能描述 商户(支付宝签约商户)可将用户(支付宝签约商户的用户)在商户网站的积分兑 换成集分宝充值到用户的支付宝账户中。 1.2 阅读对象 支付宝集分宝兑换接口文档面向具有一定的网站开发能力,了解 ASP、PHP、JAVA、 ASP.NET 等开发语言中的一种及 SQL 数据库语言的网站开发、维护和管理人员。 1.3 业务术语 表1-1 业务术语 解释 通过 HTTP 协议把需要传输的数据发送给接收方的过程。 同步返回查询数据。支付宝根据查询参数,查询出数据后,以 XML 的格式返回给商户。 集分宝是支付宝集分宝的网站名称。用户可在集分宝网站获得并使用支付宝集分宝,同时可 以查询支付宝集分宝的余额和使用明细等。 支付宝集分宝,是用户在支付宝网站的活跃度、贡献值的集中体现,用户可以通过使用支付 宝交易、缴水电煤费、还信用卡款等一些行为来获得支付宝集分宝;同时可在支付宝收银台 使用集分宝抵扣交易中部份现金额度,并且可在集分宝频道用集分宝兑换精美礼品或参与支 付宝的各类抽奖活动等。 术语 请求 返回 集分宝 支付宝(中国)网络技术有限公司 版权所有| 版本:1.5 第 4 页
集分宝兑换接口 2 功能演示 商户会员 商户系统 支付宝系统 申请将商户积分 兑换成集分宝 调用集分宝兑换 接口 给用户的支付 宝账户增加集 分宝 返回处理结果 图2-1 集分宝兑换流程图 3 数据交互 图3-1 商户系统请求/支付宝响应交互模式 (1) 构造请求数据 商户根据支付宝提供的接口规则,通过程序生成得到签名结果及要传输给支付宝的 数据集合。 (2) 发送请求数据 把构造完成的数据集合,通过页面链接跳转或表单提交的方式传递给支付宝。 (3) 支付宝对请求数据进行处理 支付宝(中国)网络技术有限公司 版权所有| 版本:1.5 第 5 页
集分宝兑换接口 支付宝得到这些集合后,会先进行安全校验等验证,一系列验证通过后便会处理完 成这次发送过来的数据请求。 (4) 返回处理的结果数据 支付宝会把处理完成的结果数据以 XML 的形式返回给商户。 (5) 对获取的返回结果数据进行处理 商户利用编程方法来模拟http 请求远程解析XML,获取支付宝返回的结果数据后, 可以结合自身网站的业务逻辑进行数据处理。 4 请求参数说明 4.1 含义 请求参数是商户在与支付宝进行数据交互时,提供给支付宝的请求数据,以便支付 宝根据这些数据进一步处理。 4.2 列表 表4-1 请求参数说明 参数 参数名称 类型(字 节长度) 参数说明 是否可 为空 样例 基本参数 service 接口名称 String 接口名称。 不可空 generalpoint_add_point partner 合作者身份 ID String(1 6) 签约的支付宝账号对应的支 付宝唯一用户号。 以 2088 开头的 16 位纯数字 组成。 不可空 2088001159940003 sign 签名 String 请参见“7 签名机制”。 不可空 966408c5e1914221a91 78ed24d1297cc sign_ty pe 签名方式 String DSA、RSA、MD5 三个值可 选,必须大写。 不可空 MD5 _input_ charset 参数编码字 符集 String 商户网站使用的编码格式, 如 utf-8、gbk、gb2312 等。 可空 UTF-8 业务参数 支付宝(中国)网络技术有限公司 版权所有| 版本:1.5 第 6 页
集分宝兑换接口 参数 参数名称 类型(字 节长度) 参数说明 是否可 为空 样例 amoun t out_biz _no 集分宝数 商户业务号 Number (12) String(3 2) 商户需要给用户的支付宝账 户增加多少个集分宝。 不可空 1000 商户业务流水号(同一商户 需保证唯一性)。 不可空 4587639423678204 out_biz _time 商户业务时 间 String logon_i d 支付宝登录 账号 String(6 4) user_id 支付宝用户 号 String(1 6) out_us er_id 商户会员标 识 String(6 4) 不可空 2011-10-10 10:10:10 业务发生时间。格式: yyyy-MM-dd HH:mm:ss。 取值范围: 当前时间前三个月< out_biz_time < 当前时间后 一天 说明: 如果本参数取值不在规定时 间 范 围 内 , 将 返 回 错 误 码 OUT_BIZ_TIME_OVERFL OW。 用户的支付宝登录账号,支 持邮箱格式或手机号码格 式。 说明: logon_id 和 user_id 选择 可空 xy1@alitest.com 其一传入,不可同时传入 或同时为空。 该参数即将废弃,不建议 使用。 用户支付宝账号对应的支付 宝唯一用户号。 以 2088 开头的纯 16 位数字。 说明: logon_id 和 user_id 选择其一 传入,不可同时传入或同时 为空。 用户在商户网站的身份标识 (商户需保证其唯一性)。 说明: 该参数做签名时使用原始数 据,请求发出之前需要对该 值做 URL Encode 后再发出。 可空 2088102114356225 可空 a1438546 支付宝(中国)网络技术有限公司 版权所有| 版本:1.5 第 7 页
集分宝兑换接口 参数 参数名称 类型(字 节长度) 参数说明 是否可 为空 样例 out_poi nt_am ount 扣除商户积 分数 Number (12) 指商户扣除用户在商户网站 的积分数(用于兑换成集分 宝)。 可空 1000 发放业务配置 ID(由支付宝 相关人员提供)。 用于一个 partner 对应多个集 分宝预算库的情况,以确定 使用某个特定的预算库发放 集分宝,此时 dispatch_config_id 不可为 空。 可空 1002 dispatc h_confi g_id 发放配置 ID String(1 6) 说明: 部分参数类型为 String,未指明长度范围,表明系统不校验该参数的长度; 本接口保证同一笔订单只处理一次,不会发生重复兑换的情况,如果商户调用 本接口没有得到支付宝响应,可以使用同一个业务号再次调用本接口进行兑换。 4.3 样例 https://mapi.alipay.com/gateway.do?sign_type=MD5&out_biz_no=45876394236 78204&sign=966408c5e1914221a9178ed24d1297cc&amount=1000&_input_ch arset=UTF-8&out_biz_time=2011-10-10+10%3A10%3A10&out_user_id=a1438 546&service=generalpoint_add_point&dispatch_config_id=1002&out_point_amo unt=1000&partner=2088001159940003&logon_id=xy1%40alitest.com 说明: 本样例仅供参考,支付宝网关为https://mapi.alipay.com/gateway.do。 支付宝(中国)网络技术有限公司 版权所有| 版本:1.5 第 8 页
分享到:
收藏