很可惜 T 。T 您現(xiàn)在還不是作者身份，不能自主發(fā)稿哦～
如有投稿需求，請(qǐng)把文章發(fā)送到郵箱tougao@appcpx.com，一經(jīng)錄用會(huì)有專人和您聯(lián)系
咨詢?nèi)绾纬蔀榇河鹱髡哒?qǐng)聯(lián)系：鳥(niǎo)哥筆記小羽毛（ngbjxym）
API接口是不同程序之間的”外交語(yǔ)言“。程序之間通過(guò)發(fā)送請(qǐng)求參數(shù)至接口url，經(jīng)過(guò)后臺(tái)處理邏輯，返回所需的結(jié)果。
一份完整的接口文檔，包含了業(yè)務(wù)流程、業(yè)務(wù)要素和交易結(jié)構(gòu)，也部分影響了數(shù)據(jù)庫(kù)表設(shè)計(jì)。
產(chǎn)品、研發(fā)、測(cè)試可以根據(jù)接口文檔進(jìn)行產(chǎn)品設(shè)計(jì)、開(kāi)發(fā)、測(cè)試，毫不夸張的說(shuō)懂得了接口設(shè)計(jì)，間接就懂了產(chǎn)品的設(shè)計(jì)思路。
剩下的工作無(wú)非是對(duì)細(xì)節(jié)的填充和文檔以及對(duì)外溝通講解，授人以魚(yú)不如授人以漁，我的文章只主要講漁，一些實(shí)例作為示范，以達(dá)到知行合一的效果。
以下闡述接口設(shè)計(jì)的基本設(shè)計(jì)邏輯和業(yè)務(wù)邏輯，基于此結(jié)合視頻課程講解，以達(dá)到具備業(yè)務(wù)設(shè)計(jì)的能力。
1、接口調(diào)用雙方：
調(diào)用方：根據(jù)接口地址傳參
被調(diào)用方：提供接口服務(wù)和地址
查詢接口：適合異步結(jié)果返回場(chǎng)景
通知接口：適合異步結(jié)果通知，以及消息推送場(chǎng)景
2、公共參數(shù)
公共參數(shù)是每個(gè)接口都要攜帶的參數(shù)，描述每個(gè)接口的基本信息，放在header或url參數(shù)中。
例如：
版本 version1.0.1
產(chǎn)品代碼10000
項(xiàng)目編碼 04055
3、接口入?yún)?/strong>
接口入?yún)?，用于傳給接口被調(diào)用方的數(shù)據(jù)，接口被調(diào)用方獲取到接口調(diào)用方的參數(shù)后，進(jìn)行邏輯處理或者保持?jǐn)?shù)據(jù)。例如：
授信流水號(hào)
客戶姓名
客戶身份證
4、接口出參
接口被調(diào)用方根據(jù)處理邏輯結(jié)構(gòu)，接口出參會(huì)實(shí)時(shí)返回給接口調(diào)用方，
例如：
響應(yīng)碼（code）
信息描述（message）
響應(yīng)數(shù)據(jù)（data）
其中接口響應(yīng)碼可以一個(gè)字段，也可以分成兩個(gè)字段
共用一個(gè)字段：
接口成功：0000；
接口失?。?/p>
9999 接口失?。?/p>
8888 黑名單；
6666 營(yíng)業(yè)時(shí)間校驗(yàn)；
5555 年齡校驗(yàn)。
…
兩個(gè)狀態(tài)用兩個(gè)字段
分別是接口響應(yīng)狀態(tài)和業(yè)務(wù)處理狀態(tài)
接口響應(yīng)狀態(tài)：成功0000；失敗9999
業(yè)務(wù)處理狀態(tài)：成功、失敗、處理中
如果業(yè)務(wù)處理失敗，返回錯(cuò)誤原因分類
錯(cuò)誤原因
(證件照片模糊) 1001
(人臉照模糊) 1002
風(fēng)控原因拒絕 1003
.....
1、授信流程
授信前置校驗(yàn)
接口描述：校驗(yàn)客戶是否命中黑名單，額度互斥等規(guī)則
入?yún)ⅲ菏謾C(jī)號(hào)、姓名、身份證號(hào)
出參：是否通過(guò)、拒絕原因
授信申請(qǐng)接口
接口描述：發(fā)起授信申請(qǐng)，需要返回是否已受理申請(qǐng)
入?yún)ⅲ?/p>
授信流水號(hào)、授信流水號(hào)、手機(jī)號(hào)、 姓名、 身份證號(hào)、 身份證正面照片 、身份證背面照片、 大頭照 、反欺詐信息 jason 、風(fēng)險(xiǎn)信息 jason 。
出生日期 、身份證有效期開(kāi)始時(shí)間 、身份證有效期結(jié)束時(shí)間 、簽發(fā)機(jī)關(guān) 、民族、 身份證地址、 性別。
出參：
狀態(tài)：0000成功 or9999失敗。
授信通知接口
接口描述：通知授信申請(qǐng)結(jié)果
入?yún)ⅲ河脩艟幪?hào) 、授信流水號(hào)、審核結(jié)果 、拒絕錯(cuò)誤碼 、拒絕原因 、下一次申請(qǐng)時(shí)間間隔
出參：無(wú)
授信接口查詢
接口描述
查詢授信申請(qǐng)的處理結(jié)果（成功/失敗/處理中）
入?yún)?/p>
授信流水號(hào)
出參
授信流水號(hào)、 審核結(jié)果、 用戶編號(hào)、 拒絕錯(cuò)誤碼、 拒絕原因、 下一次申請(qǐng)時(shí)間
額度利率查詢
接口描述：查詢賬戶信息，如授信額度、可用額度
入?yún)ⅲ河脩艟幪?hào)
出參：額度狀態(tài)、 授信額度、 可用額度、 合同生效日期 、合同失效日期 年利率
2、用信接口
用信申請(qǐng)借款
接口描述：發(fā)起借款申請(qǐng)
入?yún)ⅲ河脩艟幪?hào) 、處理流水號(hào)、 貸款金額、 貸款期數(shù)、 還款方式 、優(yōu)惠券Code、 銀行卡號(hào)等
出參：狀態(tài)：0000成功 or9999失敗。
借款試算接口
接口描述：試算客戶借款的應(yīng)還金額
入?yún)ⅲ河脩艟幪?hào) 貸款金額 貸款期數(shù) 還款方式 優(yōu)惠券Code
出參：總還款本金 、總利息金額 、總還款金額、 優(yōu)惠總金額
list {每期到期還款日 、每期還款總額、 每期還款本金、 每期還款利息、 每期優(yōu)惠金額}end list
用信申請(qǐng)查詢
接口描述：主動(dòng)查詢還款結(jié)果狀態(tài)
入?yún)ⅲ河脩艟幪?hào) 、借據(jù)號(hào)
出參：放款狀態(tài)、拒絕原因、拒絕碼值、放款日期
用信申請(qǐng)通知
接口描述：接收異步的還款結(jié)構(gòu)通知
入?yún)ⅲ?span>用戶編號(hào) 、借款處理流水號(hào) 、放款狀態(tài) 、拒絕碼值、 拒絕原因 、放款日期。
出參： 無(wú)
還款試算
接口描述：發(fā)起試算返回本次還款的金額
入?yún)ⅲ河脩艟幪?hào)、借據(jù)號(hào) 、還款方式
出參：還款總額 、還款本金、 還款利息 、還款罰息
還款申請(qǐng)
接口描述:發(fā)起還款申請(qǐng)
入?yún)ⅲ河脩艟幪?hào) 、還款流水號(hào) 、還款方式、 借據(jù)號(hào)、 還款金額、 銀行卡卡號(hào)
出參：還款狀態(tài)、失敗碼值、失敗原因
還款結(jié)果通知
接口描述：主動(dòng)通知調(diào)用方還款結(jié)果
入?yún)ⅲ河脩艟幪?hào) 、還款流水號(hào)、 還款狀態(tài) 、失敗碼值、失敗原因、 還款完成時(shí)間
出參：無(wú)
還款結(jié)果查詢
接口描述:查詢還款申請(qǐng)的處理結(jié)果（成功/失敗/處理中）
入?yún)ⅲ河脩艟幪?hào) 、還款處理流水號(hào)
出參：還款流水號(hào) 、還款狀態(tài)、 失敗碼值、 失敗原因 、還款完成時(shí)間、 還款卡號(hào) 、還款本金 、還款利息 、還款罰息 、還款總金額。
還款計(jì)劃查詢
接口描述：查詢借據(jù)的還款計(jì)劃
入?yún)ⅲ?span>用戶編號(hào) 、借據(jù)號(hào)
出參:list{期次、狀態(tài)、 到期還款日、 罰息、 優(yōu)惠金額、 本期應(yīng)還款 、本期應(yīng)還本金 、本期應(yīng)還利息}end list
協(xié)議查詢
協(xié)議查詢
接口描述：查詢授信/綁卡/借款流程需要簽署的協(xié)議
入?yún)ⅲ?/p>
協(xié)議類型、 簽訂時(shí)間 、用戶姓名、 身份證號(hào)碼、 申請(qǐng)金額、 用戶編號(hào) 、申請(qǐng)期數(shù)、 還款方式、 銀行卡號(hào)碼、 手機(jī)號(hào)碼
出參:
協(xié)議列表、協(xié)議名字 、協(xié)議類型、協(xié)議內(nèi)容、強(qiáng)制閱讀時(shí)間、閱讀順序、協(xié)議內(nèi)容類型
已簽約協(xié)議下載
接口描述：查詢授信/綁卡/借款流程已簽署的協(xié)議
入?yún)?/p>
用戶編號(hào)、借據(jù)號(hào)
出參
協(xié)議列表、協(xié)議名字 、協(xié)議類型 、協(xié)議內(nèi)容、 協(xié)議內(nèi)容類型
文件處理
文件上傳
接口描述：使用此接口上傳文件（身份證正反面照片、人臉照等），返回上傳到文件id
入?yún)?/p>
用戶編號(hào) 、流水號(hào)、 場(chǎng)景、 文件Base64 類型
出參
文件id
文件下載
接口描述：使用此接口下載文件
入?yún)?/p>
文件id
出參
文件Base64 類型
以上即為一份簡(jiǎn)化版本的api接口文檔的骨架，其信息流、文件流都是統(tǒng)一的，其本質(zhì)是在歷史實(shí)踐經(jīng)驗(yàn)+基本設(shè)計(jì)原則的共同基礎(chǔ)上決定的。
本文為作者獨(dú)立觀點(diǎn)，不代表鳥(niǎo)哥筆記立場(chǎng)，未經(jīng)允許不得轉(zhuǎn)載。
《鳥(niǎo)哥筆記版權(quán)及免責(zé)申明》 如對(duì)文章、圖片、字體等版權(quán)有疑問(wèn)，請(qǐng)點(diǎn)擊 反饋舉報(bào)
上一篇
我們致力于提供一個(gè)高質(zhì)量?jī)?nèi)容的交流平臺(tái)。為落實(shí)國(guó)家互聯(lián)網(wǎng)信息辦公室“依法管網(wǎng)、依法辦網(wǎng)、依法上網(wǎng)”的要求，為完善跟帖評(píng)論自律管理，為了保護(hù)用戶創(chuàng)造的內(nèi)容、維護(hù)開(kāi)放、真實(shí)、專業(yè)的平臺(tái)氛圍，我們團(tuán)隊(duì)將依據(jù)本公約中的條款對(duì)注冊(cè)用戶和發(fā)布在本平臺(tái)的內(nèi)容進(jìn)行管理。平臺(tái)鼓勵(lì)用戶創(chuàng)作、發(fā)布優(yōu)質(zhì)內(nèi)容，同時(shí)也將采取必要措施管理違法、侵權(quán)或有其他不良影響的網(wǎng)絡(luò)信息。
一、根據(jù)《網(wǎng)絡(luò)信息內(nèi)容生態(tài)治理規(guī)定》《中華人民共和國(guó)未成年人保護(hù)法》等法律法規(guī)，對(duì)以下違法、不良信息或存在危害的行為進(jìn)行處理。
1. 違反法律法規(guī)的信息，主要表現(xiàn)為：
1)反對(duì)憲法所確定的基本原則；
2)危害國(guó)家安全，泄露國(guó)家秘密，顛覆國(guó)家政權(quán)，破壞國(guó)家統(tǒng)一，損害國(guó)家榮譽(yù)和利益；
3)侮辱、濫用英烈形象，歪曲、丑化、褻瀆、否定英雄烈士事跡和精神，以侮辱、誹謗或者其他方式侵害英雄烈士的姓名、肖像、名譽(yù)、榮譽(yù)；
4)宣揚(yáng)恐怖主義、極端主義或者煽動(dòng)實(shí)施恐怖活動(dòng)、極端主義活動(dòng)；
5)煽動(dòng)民族仇恨、民族歧視，破壞民族團(tuán)結(jié)；
6)破壞國(guó)家宗教政策，宣揚(yáng)邪教和封建迷信；
7)散布謠言，擾亂社會(huì)秩序，破壞社會(huì)穩(wěn)定；
8)宣揚(yáng)淫穢、色情、賭博、暴力、兇殺、恐怖或者教唆犯罪；
9)煽動(dòng)非法集會(huì)、結(jié)社、游行、示威、聚眾擾亂社會(huì)秩序；
10)侮辱或者誹謗他人，侵害他人名譽(yù)、隱私和其他合法權(quán)益；
11)通過(guò)網(wǎng)絡(luò)以文字、圖片、音視頻等形式，對(duì)未成年人實(shí)施侮辱、誹謗、威脅或者惡意損害未成年人形象進(jìn)行網(wǎng)絡(luò)欺凌的；
12)危害未成年人身心健康的；
13)含有法律、行政法規(guī)禁止的其他內(nèi)容；
2. 不友善：不尊重用戶及其所貢獻(xiàn)內(nèi)容的信息或行為。主要表現(xiàn)為：
1)輕蔑：貶低、輕視他人及其勞動(dòng)成果；
2)誹謗：捏造、散布虛假事實(shí)，損害他人名譽(yù)；
3)嘲諷：以比喻、夸張、侮辱性的手法對(duì)他人或其行為進(jìn)行揭露或描述，以此來(lái)激怒他人；
4)挑釁：以不友好的方式激怒他人，意圖使對(duì)方對(duì)自己的言論作出回應(yīng)，蓄意制造事端；
5)羞辱：貶低他人的能力、行為、生理或身份特征，讓對(duì)方難堪；
6)謾罵：以不文明的語(yǔ)言對(duì)他人進(jìn)行負(fù)面評(píng)價(jià)；
7)歧視：煽動(dòng)人群歧視、地域歧視等，針對(duì)他人的民族、種族、宗教、性取向、性別、年齡、地域、生理特征等身份或者歸類的攻擊；
8)威脅：許諾以不良的后果來(lái)迫使他人服從自己的意志；
3. 發(fā)布垃圾廣告信息：以推廣曝光為目的，發(fā)布影響用戶體驗(yàn)、擾亂本網(wǎng)站秩序的內(nèi)容，或進(jìn)行相關(guān)行為。主要表現(xiàn)為：
1)多次發(fā)布包含售賣產(chǎn)品、提供服務(wù)、宣傳推廣內(nèi)容的垃圾廣告。包括但不限于以下幾種形式：
2)單個(gè)帳號(hào)多次發(fā)布包含垃圾廣告的內(nèi)容；
3)多個(gè)廣告帳號(hào)互相配合發(fā)布、傳播包含垃圾廣告的內(nèi)容；
4)多次發(fā)布包含欺騙性外鏈的內(nèi)容，如未注明的淘寶客鏈接、跳轉(zhuǎn)網(wǎng)站等，誘騙用戶點(diǎn)擊鏈接
5)發(fā)布大量包含推廣鏈接、產(chǎn)品、品牌等內(nèi)容獲取搜索引擎中的不正當(dāng)曝光；
6)購(gòu)買或出售帳號(hào)之間虛假地互動(dòng)，發(fā)布干擾網(wǎng)站秩序的推廣內(nèi)容及相關(guān)交易。
7)發(fā)布包含欺騙性的惡意營(yíng)銷內(nèi)容，如通過(guò)偽造經(jīng)歷、冒充他人等方式進(jìn)行惡意營(yíng)銷；
8)使用特殊符號(hào)、圖片等方式規(guī)避垃圾廣告內(nèi)容審核的廣告內(nèi)容。
4. 色情低俗信息，主要表現(xiàn)為：
1)包含自己或他人性經(jīng)驗(yàn)的細(xì)節(jié)描述或露骨的感受描述；
2)涉及色情段子、兩性笑話的低俗內(nèi)容；
3)配圖、頭圖中包含庸俗或挑逗性圖片的內(nèi)容；
4)帶有性暗示、性挑逗等易使人產(chǎn)生性聯(lián)想；
5)展現(xiàn)血腥、驚悚、殘忍等致人身心不適；
6)炒作緋聞、丑聞、劣跡等；
7)宣揚(yáng)低俗、庸俗、媚俗內(nèi)容。
5. 不實(shí)信息，主要表現(xiàn)為：
1)可能存在事實(shí)性錯(cuò)誤或者造謠等內(nèi)容；
2)存在事實(shí)夸大、偽造虛假經(jīng)歷等誤導(dǎo)他人的內(nèi)容；
3)偽造身份、冒充他人，通過(guò)頭像、用戶名等個(gè)人信息暗示自己具有特定身份，或與特定機(jī)構(gòu)或個(gè)人存在關(guān)聯(lián)。
6. 傳播封建迷信，主要表現(xiàn)為：
1)找人算命、測(cè)字、占卜、解夢(mèng)、化解厄運(yùn)、使用迷信方式治??；
2)求推薦算命看相大師；
3)針對(duì)具體風(fēng)水等問(wèn)題進(jìn)行求助或咨詢；
4)問(wèn)自己或他人的八字、六爻、星盤、手相、面相、五行缺失，包括通過(guò)占卜方法問(wèn)婚姻、前程、運(yùn)勢(shì)，東西寵物丟了能不能找回、取名改名等；
7. 文章標(biāo)題黨，主要表現(xiàn)為：
1)以各種夸張、獵奇、不合常理的表現(xiàn)手法等行為來(lái)誘導(dǎo)用戶；
2)內(nèi)容與標(biāo)題之間存在嚴(yán)重不實(shí)或者原意扭曲；
3)使用夸張標(biāo)題，內(nèi)容與標(biāo)題嚴(yán)重不符的。
8.「飯圈」亂象行為，主要表現(xiàn)為：
1)誘導(dǎo)未成年人應(yīng)援集資、高額消費(fèi)、投票打榜
2)粉絲互撕謾罵、拉踩引戰(zhàn)、造謠攻擊、人肉搜索、侵犯隱私
3)鼓動(dòng)「飯圈」粉絲攀比炫富、奢靡享樂(lè)等行為
4)以號(hào)召粉絲、雇用網(wǎng)絡(luò)水軍、「養(yǎng)號(hào)」形式刷量控評(píng)等行為
5)通過(guò)「蹭熱點(diǎn)」、制造話題等形式干擾輿論，影響傳播秩序
9. 其他危害行為或內(nèi)容，主要表現(xiàn)為：
1)可能引發(fā)未成年人模仿不安全行為和違反社會(huì)公德行為、誘導(dǎo)未成年人不良嗜好影響未成年人身心健康的；
2)不當(dāng)評(píng)述自然災(zāi)害、重大事故等災(zāi)難的；
3)美化、粉飾侵略戰(zhàn)爭(zhēng)行為的；
4)法律、行政法規(guī)禁止，或可能對(duì)網(wǎng)絡(luò)生態(tài)造成不良影響的其他內(nèi)容。
二、違規(guī)處罰
本網(wǎng)站通過(guò)主動(dòng)發(fā)現(xiàn)和接受用戶舉報(bào)兩種方式收集違規(guī)行為信息。所有有意的降低內(nèi)容質(zhì)量、傷害平臺(tái)氛圍及欺凌未成年人或危害未成年人身心健康的行為都是不能容忍的。
當(dāng)一個(gè)用戶發(fā)布違規(guī)內(nèi)容時(shí)，本網(wǎng)站將依據(jù)相關(guān)用戶違規(guī)情節(jié)嚴(yán)重程度，對(duì)帳號(hào)進(jìn)行禁言 1 天、7 天、15 天直至永久禁言或封停賬號(hào)的處罰。當(dāng)涉及欺凌未成年人、危害未成年人身心健康、通過(guò)作弊手段注冊(cè)、使用帳號(hào)，或者濫用多個(gè)帳號(hào)發(fā)布違規(guī)內(nèi)容時(shí)，本網(wǎng)站將加重處罰。
三、申訴
隨著平臺(tái)管理經(jīng)驗(yàn)的不斷豐富，本網(wǎng)站出于維護(hù)本網(wǎng)站氛圍和秩序的目的，將不斷完善本公約。
如果本網(wǎng)站用戶對(duì)本網(wǎng)站基于本公約規(guī)定做出的處理有異議，可以通過(guò)「建議反饋」功能向本網(wǎng)站進(jìn)行反饋。
(規(guī)則的最終解釋權(quán)歸屬本網(wǎng)站所有)