好的收款接口及相应的说明文档
来源:互联网 发布:防晒霜推荐知乎 编辑:程序博客网 时间:2024/06/05 15:29
需要对接一个接口时,一般先要阅读这个接口的文档,一个好的收款接口及相应的说明文档应该包含以下几个方面:
接口作用描述
描述这个收款支付接口的一般使用场景,给阅读者一个整体概念。
整体调用过程描述
描述这个收款支付接口的在各种情况下如何调用其他相关后续接口。比如收款检测接口,退款接口等
输入参数作用描述
描述这个收款接口所有输入参数的要求和作用。
不同场景输入参数举例
对不同场景下输入参数的举例,让阅读者有直观认识。
返回参数完整,说明清晰
描述这个接口的所有返回参数的作用,并且保证返回参数能够满足所有业务方的需要。
返回结果判定依据清晰
根据返回参数能够清晰准确地判断当前支付请求的状态。
错误码表完整,说明清晰
有完整的错误码及相应描述,既便于调用方能够根据错误码进行相应的后续处理,还能提高对接开发效率。
有相应支付检测接口
有支付检测接口可以随时查询当前支付请求的状态
有代码Demo供参考
降低开发者的入门难度,提高对接开发效率。
收款检测接口及相应的说明文档应该包含以下几个方面:
输入参数完整
检测的输入参数支持使用商户订单号及第三方订单号
返回参数完整,说明清晰
描述这个接口的所有返回参数的作用,并且保证返回参数能够满足所有业务方的需要。
返回结果判定依据清晰
根据返回参数能够清晰准确地判断当前支付请求的状态。
错误码表完整,说明清晰
有完整的错误码及相应描述,既便于调用方能够根据错误码进行相应的后续处理,还能提高对接开发效率。
有代码Demo供参考
降低开发者的入门难度,提高对接开发效率。
0 0
- 好的收款接口及相应的说明文档
- Android调用相应的接口
- 我的收款二维码
- Gnu tool chain in LFS-6.1.1-本文档说明相应的关键点(Why to).
- 应收发票及收款核销相关的API和程序
- CButtonST 函数接口说明 -好用的按钮类
- 分享一款简单好用的接口文档管理工具
- FI 总账科目(GL),应付款方(供应商),应收款方(客户)的主要数据库表流向及说明
- /proc/pid下的相应信息说明
- /proc/pid下的相应信息说明
- /proc/pid下的相应信息说明
- /proc/pid下的相应信息说明
- 做外贸要收款,哪些是没有拒付、效果比较好的?
- 应收发票 收款录入 收款核销产生的会计科目
- 接口调用,收到相应后的处理
- 好的文档收集
- yum的说明文档
- 好的接口
- Go语言学习笔记9
- Java中set集合
- 怎么充分利用大数据寻找商机?
- 自学PHP系列之一:xHtml技术
- Java中几个常用设计模式
- 好的收款接口及相应的说明文档
- Spring系列之J2EE开发的春天
- JAVA源码分析之---Object类(二)---hashCode,equals,clone方法的使用
- Java23种设计模式全解析
- 2016.7.9 夏令营 Day3
- 2016-07-11 Null value was assigned to a property of primitive type setter 问题
- 在 PC 端使用Bluemix的 Internet of Things Foundation 双向传达接收远程装置信息
- SSM三大框架整合详细教程(Spring+SpringMVC+MyBatis)
- 小鸟云安装LNMP环境后 使用Navcait无法连接数据库 报错10060