海创汇二期API接口.pdf

目 录 API说明书规范 1.前言 2.API公共说明 3.文档API索引 4.单个API说明 API设计开发规范 常见错误代码参考 请求体及请求签名方法 API接口列表 数据分析 共享空间分析 孵化器分析 项目分析 会员分析 基金分析 FA分析 海尔孵化小微 用户信息 本文档使用 看云 构建 - 2 - API说明书规范 API说明书规范 信息系统不可避免会与三方系统产生交互 ，本文将会定义信息系统体系下所有接口文档的一些通用约定。 API设计开发完成后 ，在保证API完整性和稳定性的情况下 ，需要对API接口进行详细的说明 ，本文档将约定如 何对API接口进行说明。 本文档使用 看云 构建 - 3 - 1.前言 1.前言 1.1 编写目的 信息系统不可避免会与三方系统产生交互 ，本文将会定义信息系统体系下所有接口文档的一些通用约定。 API设计开发完成后 ，在保证API完整性和稳定性的情况下 ，需要对API接口进行详细的说明 ，本文档将约定如何 对API接口进行说明。 注 ：本文档中所提及接口 ，都是信息系统对外提供的接口 ，接口作为被调用方。 1.2 预期读者 系统接口设计开发人员 系统接口使用人员 第三方调用 1.3 关于API设计开发 为信息系统开发的API需要仔细考虑 ，API地址名称、API输入参数、API返回值都应经过严格推敲 ，API是提供外 部三方调用 ，需要经过严格测试 ，特别是对于会修改系统数据的API要有严格的参数验证和安全性验证。 本文档使用 看云 构建 - 4 - 2.API公共说明 2.API公共说明 2.1 公共属性 API公共说明需要明确API相关公共属性 ，包含但不局限于以下表格内容。 属性 备注 以目录的形式出现 ，例如 ：项目相关接 API集名称 口、用户信息 目录中首篇文档是对该API集进行说 API集说明 明 ，并编写API地址索引。 API基地址 API所在IP或域名 例如 API调试所在IP或域名 例如 API调试地址 支持协议 Http、Https或其它支持的协议 API请求方式 支持GET/POST/PUT/DELETE/PATCH 应对API中支持的输入或相应数据结构 API基本结构 进行规约 ，并提供详细的说明。 所有API均计算签名 ，对于需要用户授 鉴权说明 权的API需要传送授权Token