XX管理系统接口需求文档
日期 2020年 月 版本号 V1.0 修订说明 编写接口文档 修订人 审核人 批准人
1. 2. 3. 4. 目录
概述 ..................................................................................................................................................... 1 1.1. 概述.............................................................................................................................................. 1 1.2. 术语约定 ...................................................................................................................................... 1 1.3. 调用接口方式 .............................................................................................................................. 1 1.4. 阅读对象 ...................................................................................................................................... 1
接口运行环境 ...................................................................................................................................... 2 2.1. 正式环境 ...................................................................................................................................... 2 2.2. 测试环境 ...................................................................................................................................... 2
接入指引.............................................................................................................................................. 2 3.1. 接口调用说明 .............................................................................................................................. 2
管理系统提供接口 .............................................................................................................................. 2 4.1. XXX接口 ....................................................................................................................................... 2
1. 概述
1.1. 概述
（项目管理系统的概述）
1.2. 术语约定
缩略语 XXX系统 接入系统
含义 XXX系统接口获取/推送数据的第三方系统 1.3. 调用接口方式
① 数据方实时推送数据到管理系统接口；
优点：实时触发，数据一致性好，更新即触发推送信息量小传输速度快； 缺点：会增加访问压力，但按照交易中心发布信息的频率来看影响比较小； 安全性：接口处理，与方式无关；采取接口加密，安全性可控； 性能：正常，按照机器的性能与web服务器性能的较优参照；
并发：无并发危害，数据推送失败可采取重试（并发危害指对共享数据进行操作）； 异常处理机制：若非系统故障式异常，采用记录异常至管理后台（若有）由管理员可知方式通知开发排查，返回错误码告知调用方异常，显示旧数据不影响系统访问。
1.4. 阅读对象
（文档阅读对象）
1
2. 接口运行环境
2.1. 正式环境
（系统环境描述）
（例子：操作系统：centeros 7.0+ Web容器：nginx、tdsql、tomcat）
2.2. 测试环境
（测试环境描述）
（例子：操作系统：centeros 7.0+ Web容器：nginx、mysql、tomcat）
3. 接入指引
3.1. 接口调用说明
请求方式：POST
成功返回示例：（代码例子）
失败返回示例：（代码例子）
4. 管理系统提供接口4.1. XXX接口
基本信息（接口基本信息描述） 接口描述：（请求参数描述）
1
管理系统接口设计文档
