接口文档模板_第1页
接口文档模板_第2页
接口文档模板_第3页
接口文档模板_第4页
接口文档模板_第5页
已阅读5页，还剩6页未读， 继续免费阅读

下载本文档

版权说明：本文档由用户提供并上传，收益归属内容提供方，若内容存在侵权，请进行举报或认领

文档简介

xxxxxxxxxxxxxx公司-接口开发组 XXX公司XXXXXXXX接口规范作者：xxx版本：1.0.1创建日期：2020年4月20日修订历史版本日期版本说明作者2020-4-201.0初版xxx第第页简介本文档详细定义了某某某系统对外提供接口规范和调用方法。登录接口规范；修改密码接口规范；编辑资料接口规范；其它；本文档旨在给第三方实现接口开发提供参考。接口规范2.1测试地址例：http://xxx.x.x.x:8080/2.2签名方法例：sign=Md5(字段1+字段2+字段3+秘钥)；注：秘钥请联系业务人员获取，一般不会公开使用。2.3加密解密加密：所有字段都必须加密后请求，否则调用失败，sign字段请拼接完成后再使用加密方法。解密：返回报文data字段需解密操作。附件：提供加解密方法。2.4其它公共内容可自行添加。2.5接口请求详细2.5.1登录接口规范功能描述该接口是实现调用验证登录及获取登录信息。接口方式httpPOST接口地址http://应用地址/登录地址/xxx接口方法请求字段参数名中文描述类型约束sign签名String必填code工号String必填passWord密码String必填返回（JSON格式）参数说明res_code返回码res_msg结果提示信息data用户信息[{"name":"姓名","age":"年龄","sex"："性别",} ]2.5.2修改密码接口规范功能描述该接口是实现调用修改密码。接口方式httpPOST接口地址http://应用地址/修改密码/xxx接口方法请求字段参数名中文描述类型约束sign签名String必填code工号String必填passWord密码String必填newPassword新密码String必填返回（JSON格式）参数说明res_code返回码res_msg结果提示信息2.5.3编辑资料接口规范功能描述该接口是实现调用修改用户资料。接口方式httpPOST接口地址http://应用地址/编辑资料/xxx接口方法请求字段参数名中文描述类型约束sign签名String必填code工号String必填passWord密码String必填age年龄String选填sex性别String选填name姓名String选填返回（JSON格式）参数说明res_code返回码res_msg结果提示信息2.5.4其它接口规范功能描述该接口是实现调用验证其它功能。接口方式httpPOST接口地址http://应用地址/其它/xxx接口方法请求字段参数名中文描述类型约束XxxXxxString必填XxxXxxString必填XxxXxxString必填返回（JSON格式）参数说明res_code返回码res_msg结果提示信息data用户信息[{"xxx":"xxx","xxx":"xxx","xxx"："xxx",} ]2.6返回码说明序号返回码说明10000验证通过，请求成功

人人文库> 全部分类> 行业资料 > 商业贸易

温馨提示

  • 1. 本站所有资源如无特殊说明，都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等，如果需要附件，请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸，网页内容里面会有图纸预览，若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间，仅对用户上传内容的表现方式做保护处理，对用户上传分享的文档内容本身不做任何修改或编辑，并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容，请与我们联系，我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

最新文档

评论

0/150

提交评论