第一创业证券企业标准
Q/FCSC 001-2024
API企业内发布规范
AP1 Published Specifications within the Enterprise
目次
前1范围..2引用文件3定义和术语，4API技术及安全要求 5API管理流程6API可观测要求.7API内部发布管理平台8API治理组织
前言
本文件按照GB/T1.1-2020《标准化工作导则第一部分：标准化文件的结构和起草规则》的规定起草.
本文件由第一创业证券股份有限公司提出.
本文件由第一创业证券股份有限公司归口.
本文件主要起草部门：第一创业证券股份有限公司信息技术中心.
本文件主要起草人：刘耀东、陈志浩、樊金峰、冯元贞、高俊、何力、贺林杰、侯心宇、吉晶、李庶原、瞿任雄、唐钉波、薛海波、靳旭、张俊跃.
API企业内发布规范
1范围
本文件规定了第一创业证券股份有限公司的API在企业内发布的可观测性、安全性、管理的要求.
本文件适用于用于企业内部系统间集成的API.
2引用文件
下列文件对于本文件的应用是必不可少的.凡是注日期的引用文件，仅所注日期的版本适用于本文件.凡是不注日期的引用文件，其最新版本（包括的修改单）适用于本文件.
《证券基金经营机构信息技术管理办法》（中国证券监督管理委员会令第179号附件一）.
3定义和术语
AP1
应用程序编程接口（英语：Application ProgrammingInterface，简称：API），是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节.
软件开发工具包（Software Development Kit），也称为开发包或者开发工具包.SDK通常是由一个或多个软件开发工具组成的集合，用于帮助开发者创建、测试和部署软件应用程序.
监控系统
对信息系统的数据采集收集、解析和处理，并实时分析、展示、响应事件.对信息系统提供即时安全警报、及时控制和可靠的系统运行.
4API技术及安全要求
4.1.API技术基本要求
a)API建议以Web服务或者SDK的形式发布.b)API被调用后，除了返回数据Data参数，还应返回结果码Code及结果说明Msg.c）API在发布前，所属系统应纳入统一监控的范围，并在监控系统中可观测API的相关信息.d）API应用程序接口应具有连接超时限制功能.e）API应用程序接口应具备接口主动断开连接的功能，具备发现恶意连接可主动处理的能力.
4.2.AP1鉴权机制要求
a）API所属系统为每个调用方系统分配单独的ID和口令.
b）API接口需要求具备身份认证功能，接口身份认证应使用如下要素组合，包括ID、数字证书、公私钥对.涉及交易接口需考虑双因子认证.致.涉及交易接口需考虑数字签名来保护交互数据完整性和不可抵赖性.d）应根据不同的应用方的服务需求，按照最小授权原则，对其相应API接口权限进行授权管
c）API接口交互安全需对交互数据有效性验证，如接口版本、参数格式是否与平台设计保持一
理.
4.3.AP1防护能力要求
a）Web类API接口应对常见网络攻击具有安全防护能力，例如防SQL注入攻击、横向越权攻击、拒绝服务攻击等.
b）SDK应具备静态递向分析防护能力、动态调试防护能力.
c）应对API接口加密密钥进行安全管理，加密和签名应分配不同的密钥，且相互分离.不应以编码的方式将私钥明文（或密文）编写在API应用程序相关代码中.私钥不应存储于API与应用方本地配置文件中，防止因代码泄露引发密钥淮露.应根据应用程序接口等级设置不同的密钥有效期，并对密钥进行定期更新.
4.4.用户隐私要求
未经授权，不应通过API采集、存储用户个人金融信息或支付缴感信息：如是外部采购API，在合作终止后，应依据与公司的约定的方式删除（或销毁）通过API应用程序接口获取的我司及其用户的相关数据.
5API管理流程
5.1.发布流程
录入API信息、主管审核、架构专家小组审核、API发布.
5.2.下架流程
提交API下架、主管审核、架构专家小组审核、API变更下架.
5.3.鉴权申请流程
提交API消费申请、API所属系统责任人审核、架构专家小组审核、自动生成鉴权口令.
6API可观测要求
6.1.API监控
a）应对API接口使用情况进行监控，记录完整访问日志.b）API集成关系可观测，由监控系统提供集成关系链路图.
