API接口設(shè)計和業(yè)務(wù)邏輯
發(fā)布日期:2022/8/24 11:36:32 瀏覽量:
api接口是不同程序之間的”外交語言“。程序之間通過發(fā)送請求參數(shù)至接口url,經(jīng)過后臺處理邏輯,返回所需的結(jié)果。
一份完整的接口文檔,包含了業(yè)務(wù)流程、業(yè)務(wù)要素和交易結(jié)構(gòu),也部分影響了數(shù)據(jù)庫表設(shè)計。
產(chǎn)品、研發(fā)、測試可以根據(jù)接口文檔進行產(chǎn)品設(shè)計、開發(fā)、測試,毫不夸張的說懂得了接口設(shè)計,間接就懂了產(chǎn)品的設(shè)計思路。
剩下的工作無非是對細節(jié)的填充和文檔以及對外溝通講解,授人以魚不如授人以漁,我的文章只主要講漁,一些實例作為示范,以達到知行合一的效果。
以下闡述接口設(shè)計的基本設(shè)計邏輯和業(yè)務(wù)邏輯,基于此結(jié)合視頻課程講解,以達到具備業(yè)務(wù)設(shè)計的能力。
一、接口設(shè)計邏輯
1、接口調(diào)用雙方:
調(diào)用方:根據(jù)接口地址傳參
被調(diào)用方:提供接口服務(wù)和地址
查詢接口:適合異步結(jié)果返回場景
通知接口:適合異步結(jié)果通知,以及消息推送場景
2、公共參數(shù)
公共參數(shù)是每個接口都要攜帶的參數(shù),描述每個接口的基本信息,放在header或url參數(shù)中。
例如:
版本 version1.0.1
產(chǎn)品代碼10000
項目編碼 04055
3、接口入?yún)?/strong>
接口入?yún)?,用于傳給接口被調(diào)用方的數(shù)據(jù),接口被調(diào)用方獲取到接口調(diào)用方的參數(shù)后,進行邏輯處理或者保持?jǐn)?shù)據(jù)。例如:
授信流水號
客戶姓名
客戶身份證
4、接口出參
接口被調(diào)用方根據(jù)處理邏輯結(jié)構(gòu),接口出參會實時返回給接口調(diào)用方,
例如:
響應(yīng)碼(code)
信息描述(message)
響應(yīng)數(shù)據(jù)(data)
其中接口響應(yīng)碼可以一個字段,也可以分成兩個字段
-
共用一個字段:
接口成功:0000;
-
接口失?。?
9999 接口失??;
8888 黑名單;
6666 營業(yè)時間校驗;
5555 年齡校驗。
-
兩個狀態(tài)用兩個字段
分別是接口響應(yīng)狀態(tài)和業(yè)務(wù)處理狀態(tài)
接口響應(yīng)狀態(tài):成功0000;失敗9999
業(yè)務(wù)處理狀態(tài):成功、失敗、處理中
如果業(yè)務(wù)處理失敗,返回錯誤原因分類
錯誤原因
-
(證件照片模糊) 1001
-
(人臉照模糊) 1002
-
風(fēng)控原因拒絕 1003
二、業(yè)務(wù)邏輯
1、授信流程
-
授信前置校驗
接口描述:校驗客戶是否命中黑名單,額度互斥等規(guī)則
入?yún)ⅲ菏謾C號、姓名、身份證號
出參:是否通過、拒絕原因
-
授信申請接口
接口描述:發(fā)起授信申請,需要返回是否已受理申請
入?yún)ⅲ?
授信流水號、授信流水號、手機號、 姓名、 身份證號、 身份證正面照片 、身份證背面照片、 大頭照 、反欺詐信息 jason 、風(fēng)險信息 jason 。
出生日期 、身份證有效期開始時間 、身份證有效期結(jié)束時間 、簽發(fā)機關(guān) 、民族、 身份證地址、 性別。
-
出參:
狀態(tài):0000成功 or9999失敗。
-
授信通知接口
接口描述:通知授信申請結(jié)果
入?yún)ⅲ河脩艟幪?、授信流水號、 審核結(jié)果 、拒 絕錯 誤碼 、拒 絕原因 、 下一次 申請時 間間隔
出參:無
-
授信接口查詢
接口描述
-
-
查詢授信申請的處理結(jié)果(成功/失敗/處理中)
-
入?yún)?
授信流水號
-
出參
授信流水號、 審核結(jié)果、 用戶編號、 拒絕錯誤碼、 拒絕原因、 下一次申請時間
-
-
額度利率查詢
接口描述:查詢賬戶信息,如授信額度、可用額度
-
入?yún)ⅲ河脩艟幪?
出參:額度狀態(tài)、 授信額度、 可用額度、 合同生效日期 、合同失效日期 年利率
2、用信接口
-
用信申請借款
-
接口描述:發(fā)起借款申請
入?yún)ⅲ河脩艟幪?、處理流水號、 貸款金額、 貸款期數(shù)、 還款方式 、優(yōu)惠券Code、 銀行卡號等
出參: 狀態(tài): 0000成功 or9999失敗。
-
借款試算接口
-
接口描述:試算客戶借款的應(yīng)還金額
入?yún)ⅲ河脩艟幪?貸款金額 貸款期數(shù) 還款方式 優(yōu)惠券Code
出參:總還款本金 、總利息金額 、總還款金額、 優(yōu)惠總金額
list {每期到期還款日 、每期還款總額、 每期還款本金、 每期還款利息、 每期優(yōu)惠金額}end list
-
用信申請查詢
-
接口描述:主動查詢還款結(jié)果狀態(tài)
入?yún)ⅲ河脩艟幪?、借據(jù)號
出參:放款狀態(tài)、拒絕原因、拒絕碼值、放款日期
-
用信申請通知
接口描述:接收異步的還款結(jié)構(gòu)通知
-
入?yún)ⅲ?用戶編號 、借款處理流水號 、放款狀態(tài) 、拒絕碼值、 拒絕原因 、放款日期。
出參: 無
三、還款接口
-
還款試算
接口描述:發(fā)起試算返回本次還款的金額
-
入?yún)ⅲ河脩艟幪?、借?jù)號 、還款方式
出參:還款總額 、還款本金、 還款利息 、還款罰息
-
還款申請
接口描述:發(fā)起還款申請
-
入?yún)ⅲ河脩艟幪?、還款流水號 、還款方式、 借據(jù)號、 還款金額、 銀行卡卡號
出參:還款狀態(tài)、失敗碼值、失敗原因
-
還款結(jié)果通知
接口描述:主動通知調(diào)用方還款結(jié)果
-
入?yún)ⅲ河脩艟幪?、還款流水號、 還款狀態(tài) 、失敗碼值、失敗原因、 還款完成時間
出參:無
-
還款結(jié)果查詢
接口描述:查詢還款申請的處理結(jié)果(成功/失敗/處理中)
-
入?yún)ⅲ河脩艟幪?、還款處理流水號
出參:還款流水號 、還款狀態(tài)、 失敗碼值、 失敗原因 、還款完成時間、 還款卡號 、還款本金 、還款利息 、還款罰息 、還款總金額。
-
還款計劃查詢
接口描述:查詢借據(jù)的還款計劃
-
入?yún)ⅲ?用戶編號 、借據(jù)號
出參:list{期次、狀態(tài)、 到期還款日、 罰息、 優(yōu)惠金額、 本期應(yīng)還款 、本期應(yīng)還本金 、本期應(yīng)還利息}end list
協(xié)議查詢
-
協(xié)議查詢
接口描述:查詢授信/綁卡/借款流程需要簽署的協(xié)議
-
入?yún)ⅲ?
協(xié)議類型、 簽訂時間 、用戶姓名、 身份證號碼、 申請金額、 用戶編號 、申請期數(shù)、 還款方式、 銀行卡號碼、 手機號碼
出參:
協(xié)議列表、協(xié)議名字 、協(xié)議類型、協(xié)議內(nèi)容、強制閱讀時間、閱讀順序、協(xié)議內(nèi)容類型
-
已簽約協(xié)議下載
接口描述:查詢授信/綁卡/借款流程已簽署的協(xié)議
-
入?yún)?
用戶編號、借據(jù)號
出參
協(xié)議列表、協(xié)議名字 、協(xié)議類型 、協(xié)議內(nèi)容、 協(xié)議內(nèi)容類型
文件處理
-
文件上傳
接口描述:使用此接口上傳文件(身份證正反面照片、人臉照等),返回上傳到文件id
-
-
入?yún)?
用戶編號 、流水號、 場景、 文件Base64 類型
-
出參
文件id
-
-
文件下載
接口描述:使用此接口下載文件
-
-
入?yún)?
文件id
-
出參
文件Base64 類型
以上即為一份簡化版本的api接口文檔的骨架,其信息流、文件流都是統(tǒng)一的,其本質(zhì)是在歷史實踐經(jīng)驗+基本設(shè)計原則的共同基礎(chǔ)上決定的。
-
馬上咨詢: 如果您有業(yè)務(wù)方面的問題或者需求,歡迎您咨詢!我們帶來的不僅僅是技術(shù),還有行業(yè)經(jīng)驗積累。
QQ: 39764417/308460098 Phone: 13 9800 1 9844 / 135 6887 9550 聯(lián)系人:石先生/雷先生