很可惜 T 。T 您现在还不是作者身份，不能自主发稿哦～
如有投稿需求，请把文章发送到邮箱tougao@appcpx.com，一经录用会有专人和您联系
咨询如何成为春羽作者请联系：鸟哥笔记小羽毛（ngbjxym）
API接口是不同程序之间的”外交语言“。程序之间通过发送请求参数至接口url，经过后台处理逻辑，返回所需的结果。
一份完整的接口文档，包含了业务流程、业务要素和交易结构，也部分影响了数据库表设计。
产品、研发、测试可以根据接口文档进行产品设计、开发、测试，毫不夸张的说懂得了接口设计，间接就懂了产品的设计思路。
剩下的工作无非是对细节的填充和文档以及对外沟通讲解，授人以鱼不如授人以渔，我的文章只主要讲渔，一些实例作为示范，以达到知行合一的效果。
以下阐述接口设计的基本设计逻辑和业务逻辑，基于此结合视频课程讲解，以达到具备业务设计的能力。
1、接口调用双方：
调用方：根据接口地址传参
被调用方：提供接口服务和地址
查询接口：适合异步结果返回场景
通知接口：适合异步结果通知，以及消息推送场景
2、公共参数
公共参数是每个接口都要携带的参数，描述每个接口的基本信息，放在header或url参数中。
例如：
版本 version1.0.1
产品代码10000
项目编码 04055
3、接口入参
接口入参，用于传给接口被调用方的数据，接口被调用方获取到接口调用方的参数后，进行逻辑处理或者保持数据。例如：
授信流水号
客户姓名
客户身份证
4、接口出参
接口被调用方根据处理逻辑结构，接口出参会实时返回给接口调用方，
例如：
响应码（code）
信息描述（message）
响应数据（data）
其中接口响应码可以一个字段，也可以分成两个字段
共用一个字段：
接口成功：0000；
接口失败：
9999 接口失败；
8888 黑名单；
6666 营业时间校验；
5555 年龄校验。
…
两个状态用两个字段
分别是接口响应状态和业务处理状态
接口响应状态：成功0000；失败9999
业务处理状态：成功、失败、处理中
如果业务处理失败，返回错误原因分类
错误原因
(证件照片模糊) 1001
(人脸照模糊) 1002
风控原因拒绝 1003
.....
1、授信流程
授信前置校验
接口描述：校验客户是否命中黑名单，额度互斥等规则
入参：手机号、姓名、身份证号
出参：是否通过、拒绝原因
授信申请接口
接口描述：发起授信申请，需要返回是否已受理申请
入参：
授信流水号、授信流水号、手机号、 姓名、 身份证号、 身份证正面照片 、身份证背面照片、 大头照 、反欺诈信息 jason 、风险信息 jason 。
出生日期 、身份证有效期开始时间 、身份证有效期结束时间 、签发机关 、民族、 身份证地址、 性别。
出参：
状态：0000成功 or9999失败。
授信通知接口
接口描述：通知授信申请结果
入参：用户编号 、授信流水号、审核结果 、拒绝错误码 、拒绝原因 、下一次申请时间间隔
出参：无
授信接口查询
接口描述
查询授信申请的处理结果（成功/失败/处理中）
入参
授信流水号
出参
授信流水号、 审核结果、 用户编号、 拒绝错误码、 拒绝原因、 下一次申请时间
额度利率查询
接口描述：查询账户信息，如授信额度、可用额度
入参：用户编号
出参：额度状态、 授信额度、 可用额度、 合同生效日期 、合同失效日期 年利率
2、用信接口
用信申请借款
接口描述：发起借款申请
入参：用户编号 、处理流水号、 贷款金额、 贷款期数、 还款方式 、优惠券Code、 银行卡号等
出参：状态：0000成功 or9999失败。
借款试算接口
接口描述：试算客户借款的应还金额
入参：用户编号 贷款金额 贷款期数 还款方式 优惠券Code
出参：总还款本金 、总利息金额 、总还款金额、 优惠总金额
list {每期到期还款日 、每期还款总额、 每期还款本金、 每期还款利息、 每期优惠金额}end list
用信申请查询
接口描述：主动查询还款结果状态
入参：用户编号 、借据号
出参：放款状态、拒绝原因、拒绝码值、放款日期
用信申请通知
接口描述：接收异步的还款结构通知
入参：用户编号 、借款处理流水号 、放款状态 、拒绝码值、 拒绝原因 、放款日期。
出参： 无
还款试算
接口描述：发起试算返回本次还款的金额
入参：用户编号、借据号 、还款方式
出参：还款总额 、还款本金、 还款利息 、还款罚息
还款申请
接口描述:发起还款申请
入参：用户编号 、还款流水号 、还款方式、 借据号、 还款金额、 银行卡卡号
出参：还款状态、失败码值、失败原因
还款结果通知
接口描述：主动通知调用方还款结果
入参：用户编号 、还款流水号、 还款状态 、失败码值、失败原因、 还款完成时间
出参：无
还款结果查询
接口描述:查询还款申请的处理结果（成功/失败/处理中）
入参：用户编号 、还款处理流水号
出参：还款流水号 、还款状态、 失败码值、 失败原因 、还款完成时间、 还款卡号 、还款本金 、还款利息 、还款罚息 、还款总金额。
还款计划查询
接口描述：查询借据的还款计划
入参：用户编号 、借据号
出参:list{期次、状态、 到期还款日、 罚息、 优惠金额、 本期应还款 、本期应还本金 、本期应还利息}end list
协议查询
协议查询
接口描述：查询授信/绑卡/借款流程需要签署的协议
入参：
协议类型、 签订时间 、用户姓名、 身份证号码、 申请金额、 用户编号 、申请期数、 还款方式、 银行卡号码、 手机号码
出参:
协议列表、协议名字 、协议类型、协议内容、强制阅读时间、阅读顺序、协议内容类型
已签约协议下载
接口描述：查询授信/绑卡/借款流程已签署的协议
入参
用户编号、借据号
出参
协议列表、协议名字 、协议类型 、协议内容、 协议内容类型
文件处理
文件上传
接口描述：使用此接口上传文件（身份证正反面照片、人脸照等），返回上传到文件id
入参
用户编号 、流水号、 场景、 文件Base64 类型
出参
文件id
文件下载
接口描述：使用此接口下载文件
入参
文件id
出参
文件Base64 类型
以上即为一份简化版本的api接口文档的骨架，其信息流、文件流都是统一的，其本质是在历史实践经验+基本设计原则的共同基础上决定的。
本文为作者独立观点，不代表鸟哥笔记立场，未经允许不得转载。
《鸟哥笔记版权及免责申明》 如对文章、图片、字体等版权有疑问，请点击 反馈举报
Powered by QINGMOB PTE. LTD. © 2010-2022 上海青墨信息科技有限公司 沪ICP备2021034055号-6
我们致力于提供一个高质量内容的交流平台。为落实国家互联网信息办公室“依法管网、依法办网、依法上网”的要求，为完善跟帖评论自律管理，为了保护用户创造的内容、维护开放、真实、专业的平台氛围，我们团队将依据本公约中的条款对注册用户和发布在本平台的内容进行管理。平台鼓励用户创作、发布优质内容，同时也将采取必要措施管理违法、侵权或有其他不良影响的网络信息。
一、根据《网络信息内容生态治理规定》《中华人民共和国未成年人保护法》等法律法规，对以下违法、不良信息或存在危害的行为进行处理。
1. 违反法律法规的信息，主要表现为：
1)反对宪法所确定的基本原则；
2)危害国家安全，泄露国家秘密，颠覆国家政权，破坏国家统一，损害国家荣誉和利益；
3)侮辱、滥用英烈形象，歪曲、丑化、亵渎、否定英雄烈士事迹和精神，以侮辱、诽谤或者其他方式侵害英雄烈士的姓名、肖像、名誉、荣誉；
4)宣扬恐怖主义、极端主义或者煽动实施恐怖活动、极端主义活动；
5)煽动民族仇恨、民族歧视，破坏民族团结；
6)破坏国家宗教政策，宣扬邪教和封建迷信；
7)散布谣言，扰乱社会秩序，破坏社会稳定；
8)宣扬淫秽、色情、赌博、暴力、凶杀、恐怖或者教唆犯罪；
9)煽动非法集会、结社、游行、示威、聚众扰乱社会秩序；
10)侮辱或者诽谤他人，侵害他人名誉、隐私和其他合法权益；
11)通过网络以文字、图片、音视频等形式，对未成年人实施侮辱、诽谤、威胁或者恶意损害未成年人形象进行网络欺凌的；
12)危害未成年人身心健康的；
13)含有法律、行政法规禁止的其他内容；
2. 不友善：不尊重用户及其所贡献内容的信息或行为。主要表现为：
1)轻蔑：贬低、轻视他人及其劳动成果；
2)诽谤：捏造、散布虚假事实，损害他人名誉；
3)嘲讽：以比喻、夸张、侮辱性的手法对他人或其行为进行揭露或描述，以此来激怒他人；
4)挑衅：以不友好的方式激怒他人，意图使对方对自己的言论作出回应，蓄意制造事端；
5)羞辱：贬低他人的能力、行为、生理或身份特征，让对方难堪；
6)谩骂：以不文明的语言对他人进行负面评价；
7)歧视：煽动人群歧视、地域歧视等，针对他人的民族、种族、宗教、性取向、性别、年龄、地域、生理特征等身份或者归类的攻击；
8)威胁：许诺以不良的后果来迫使他人服从自己的意志；
3. 发布垃圾广告信息：以推广曝光为目的，发布影响用户体验、扰乱本网站秩序的内容，或进行相关行为。主要表现为：
1)多次发布包含售卖产品、提供服务、宣传推广内容的垃圾广告。包括但不限于以下几种形式：
2)单个帐号多次发布包含垃圾广告的内容；
3)多个广告帐号互相配合发布、传播包含垃圾广告的内容；
4)多次发布包含欺骗性外链的内容，如未注明的淘宝客链接、跳转网站等，诱骗用户点击链接
5)发布大量包含推广链接、产品、品牌等内容获取搜索引擎中的不正当曝光；
6)购买或出售帐号之间虚假地互动，发布干扰网站秩序的推广内容及相关交易。
7)发布包含欺骗性的恶意营销内容，如通过伪造经历、冒充他人等方式进行恶意营销；
8)使用特殊符号、图片等方式规避垃圾广告内容审核的广告内容。
4. 色情低俗信息，主要表现为：
1)包含自己或他人性经验的细节描述或露骨的感受描述；
2)涉及色情段子、两性笑话的低俗内容；
3)配图、头图中包含庸俗或挑逗性图片的内容；
4)带有性暗示、性挑逗等易使人产生性联想；
5)展现血腥、惊悚、残忍等致人身心不适；
6)炒作绯闻、丑闻、劣迹等；
7)宣扬低俗、庸俗、媚俗内容。
5. 不实信息，主要表现为：
1)可能存在事实性错误或者造谣等内容；
2)存在事实夸大、伪造虚假经历等误导他人的内容；
3)伪造身份、冒充他人，通过头像、用户名等个人信息暗示自己具有特定身份，或与特定机构或个人存在关联。
6. 传播封建迷信，主要表现为：
1)找人算命、测字、占卜、解梦、化解厄运、使用迷信方式治病；
2)求推荐算命看相大师；
3)针对具体风水等问题进行求助或咨询；
4)问自己或他人的八字、六爻、星盘、手相、面相、五行缺失，包括通过占卜方法问婚姻、前程、运势，东西宠物丢了能不能找回、取名改名等；
7. 文章标题党，主要表现为：
1)以各种夸张、猎奇、不合常理的表现手法等行为来诱导用户；
2)内容与标题之间存在严重不实或者原意扭曲；
3)使用夸张标题，内容与标题严重不符的。
8.「饭圈」乱象行为，主要表现为：
1)诱导未成年人应援集资、高额消费、投票打榜
2)粉丝互撕谩骂、拉踩引战、造谣攻击、人肉搜索、侵犯隐私
3)鼓动「饭圈」粉丝攀比炫富、奢靡享乐等行为
4)以号召粉丝、雇用网络水军、「养号」形式刷量控评等行为
5)通过「蹭热点」、制造话题等形式干扰舆论，影响传播秩序
9. 其他危害行为或内容，主要表现为：
1)可能引发未成年人模仿不安全行为和违反社会公德行为、诱导未成年人不良嗜好影响未成年人身心健康的；
2)不当评述自然灾害、重大事故等灾难的；
3)美化、粉饰侵略战争行为的；
4)法律、行政法规禁止，或可能对网络生态造成不良影响的其他内容。
二、违规处罚
本网站通过主动发现和接受用户举报两种方式收集违规行为信息。所有有意的降低内容质量、伤害平台氛围及欺凌未成年人或危害未成年人身心健康的行为都是不能容忍的。
当一个用户发布违规内容时，本网站将依据相关用户违规情节严重程度，对帐号进行禁言 1 天、7 天、15 天直至永久禁言或封停账号的处罚。当涉及欺凌未成年人、危害未成年人身心健康、通过作弊手段注册、使用帐号，或者滥用多个帐号发布违规内容时，本网站将加重处罚。
三、申诉
随着平台管理经验的不断丰富，本网站出于维护本网站氛围和秩序的目的，将不断完善本公约。
如果本网站用户对本网站基于本公约规定做出的处理有异议，可以通过「建议反馈」功能向本网站进行反馈。
(规则的最终解释权归属本网站所有)