原创力文档- 1、原创力文档（book118）网站文档一经付费（服务费），不意味着购买了该文档的版权，仅供个人/单位学习、研究之用，不得用于商业用途，未经授权，严禁复制、发行、汇编、翻译或者网络传播等，侵权必究。。
- 2、本站所有内容均由合作方或网友上传，本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺！文档内容仅供研究参考，付费前请自行鉴别。如您付费，意味着您自己接受本站规则且自行承担风险，本站不退款、不进行额外附加服务；查看《如何避免下载的几个坑》。如果您已付费下载过本站文档，您可以点击 这里二次下载。
- 3、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等，请点击“版权申诉”（推荐），也可以打举报电话：400-050-0827(电话支持时间：9:00-18:30)。
- 4、该文档为VIP文档，如果想要下载，成为VIP会员后，下载免费。
- 5、成为VIP后，下载本文档将扣除1次下载权益。下载后，不支持退款、换文档。如有疑问请联系我们。
- 6、成为VIP后，您将拥有八大权益，权益包括：VIP文档下载权益、阅读免打扰、文档格式转换、高级专利检索、专属身份标志、高级客服、多端互通、版权登记。
- 7、VIP文档为合作方或网友上传，每下载1次， 网站将根据用户上传文档的质量评分、类型等，对文档贡献者给予高额补贴、流量扶持。如果你也想贡献VIP文档。上传文档
查看更多
XX管理系统接口需求文档
日期
版本号
修订说明
修订人
审核人
批准入
2020年 月
V1.0
编写接口文档
1.1.概述概述
1.1.
概述
概述
1.2.
术语约定
1.3.
调用接口方式
1.4.
阅读对象
妾口运行环境
2.1.
正式环境........
2.2.
测试环境........
1
1
1
1
1
2
2
2
2
2
.2
2
1.
2.
3.
4.
目录
接入指引
接口调用说明
管理系统提供接口
XXX接口
概述
概述
（项目管理系统的概述）
术语约定
缩略语
含义
XXX系统
接入系统
XXX系统接口获取/推送数据的第三方系统
调用接口方式
① 数据方实时推送数据到管理系统接口；
优点：实时触发，数据一致性好，更新即触发推送信息量小传输速度快；
缺点：会增加访问压力，但按照交易中心发布信息的频率来看影响比较小；
安全性：接口处理，与方式无关；采取接口加密，安全性可控；
性能：正常，按照机器的性能与web服务器性能的较优参照；
并发：无并发危害，数据推送失败可采取重试（并发危害指对共享数据进行操作）； 异常处理机制：若非系统故障式异常，采用记录异常至管理后台（若有）由管理员可 知方式通知开发排查，返回错误码告知调用方异常，显示旧数据不影响系统访问。
阅读对象
（文档阅读对象）
接口运行环境
正式环境
（系统环境描述）
（例子：操作系统：centeros 7.0+
Web 容器：nginx、tdsql、tomcat）
测试环境
（测试环境描述）
（例子：操作系统：centeros 7.0+
Web 容器：nginx、mysql、tomcat）
接入指引
接口调用说明
请求方式：POST
成功返回示例：（代码例子）
失败返回示例：（代码例子）
管理系统提供接口
XXX 接口
基本信息（接口基本信息描述）
接口描述：（请求参数描述）
文档评论（0）