目录
第一章 API设计... 2
1.1定义... 2
1.1.1描述... 2
1.1.2方法... 2
1.2服务器接受返回... 2
1.2.1描述... 2
1.2.2方法... 2
1.3客户端请求返回... 3
1.3.1详细描述... 3
1.3.2方法... 3
1.4设计数据库必备表... 3
第二章 附录表一... 3
第一章API设计
1.1定义
1.1.1描述
根据以下参数请求,具体参数根据具体接口说明文档为准(请求参数与返回参数复制到http://www.bejson.com/、http://json.cn/里面查询更清晰)。本API设计分类有三种,分别是公开的请求、Token+持续身份请求(2小时)、获取Token或支付高级请求
除公开请求外的其他请求都需要按照本设计完成请求
1.1.2方法
服务方式:webAPI、webservice
请求地址http://域名/XXX/VVV
请求方式: POST
请求类型:application/json
请求参数:{"User_Action":"方法名","User_Id":"APP用户ID","User_Token":"合法身份","App_FromPublicRSA":"合法渠道","App_SendBody":"实体JSON"}请求加上时间戳、随机码、APPid
返回参数:{"Return_Type":"详见附录表一中的Return_Type","Return_Massage":"提示消息"," Return_ ReceivesBody":"实体JSON "}返回加上时间戳、随机码、APPid
1.2服务器接受返回
1.2.1描述
客户端无需查看此内容
1.2.2方法
必1、通过(客户端RSA公钥)验证
必2、通过(服务器RSA私钥)转换明文
3、解析数据
4、保存请求记录
5、操作XXXXXX
6、修改请求状态:状态
必7、通过(客户端RSA公钥)转换密文
必8、通过(服务器RSA私钥)认证
必7、返回数据
1.3客户端请求返回
1.3.1详细描述
1、如何获取服务器RSA公钥? 答:通过接口GetServerRSAPublic。
2、如何验证?答:百度具体语言的验证RSA方法。
3、如何获取客户端RSA私钥?答:首次需要生成一对RSA公私密钥,公钥调用SetClintRSAPublic与服务器商定好,私钥并永久保存到应用中,证明是改应用的合法的渠道。
4、顺序必须按照以下顺序调用
1.3.2方法
请求接口
1、通过(服务器RSA公钥)转换密文
2、通过(客户端RSA私钥)认证
接受数据
1、通过(服务器RSA公钥)验证
2、通过(客户端RSA私钥)转换明文
1.4设计数据库必备表
1.5 举例操作
1.5.1 客户端发送消息给服务器
客户端以下内容给服务器(简称:客-明文):
{"User_Action":"方法名","User_Id":"APP用户ID","User_Token":"合法身份","App_FromPublicRSA":"合法渠道","App_SendBody":"实体JSON"}
服务器返回数据(简称:服-明文):
{"Return_Type":"详见附录表一中的Return_Type","Return_Massage":"提示消息"," Return_ ReceivesBody":"实体JSON"}
1.5.1.1【服务器客户端】准备前工作:
1、 客户端生成一对公私钥json如下:(注1:生成的公私钥转换成base64进行传输)
PublicKey:公钥 (服、客) PrivateKey:私钥(客)
{