接口是什么

API接??門（?）：讀懂API接??檔

本??錄：

API接?是什么？

為什么我們需要API接?？

API接?的核?

?、API接?是什么？

我們來(lái)以?個(gè)常見(jiàn)的數(shù)學(xué)公式理解API，?如y=x+2，當(dāng)x=2的時(shí)候，y=4，對(duì)么？

那此時(shí)，我們把y=x+2稱為接?，x=2稱為參數(shù)，y=4稱為返回結(jié)果，那這個(gè)接?的功能就是能把我們輸?的數(shù)加上2（注意：這?你可以發(fā)現(xiàn)接

???是帶有邏輯的）。

類?地，我們來(lái)理解?個(gè)常見(jiàn)的場(chǎng)景，?如現(xiàn)在有?個(gè)可以把經(jīng)緯度轉(zhuǎn)化為城市的接?，那當(dāng)我輸?經(jīng)度是55°，緯度是88°的時(shí)候，接?通過(guò)

??的邏輯運(yùn)算，返回結(jié)果告訴我：杭州市。

這樣你就可以清晰地了解百度百科的官?解釋了，接?就是預(yù)先定義的函數(shù)邏輯，他是供其他系統(tǒng)請(qǐng)求，然后返回結(jié)果的?個(gè)東西。

?、為什么我們需要API接?？

背景：我們的業(yè)務(wù)系統(tǒng)涉及多?多?，如果要?個(gè)公司或者?個(gè)系統(tǒng)把所有業(yè)務(wù)都做完，那未免?作量太?了吧？并且如果其他系統(tǒng)或公司有更好

的運(yùn)算邏輯，那我們?cè)谠O(shè)計(jì)功能的時(shí)候可以考慮利?接?進(jìn)?開(kāi)發(fā)。

核?需求：利?現(xiàn)有接?可以降低開(kāi)發(fā)成本，縮短開(kāi)發(fā)成本。

舉個(gè)例?：?如我是打車的APP，現(xiàn)在我需要在我的頁(yè)?上展現(xiàn)地圖的功能，對(duì)于我司??，新做地圖功能未免成本過(guò)?，那我們可以在?德開(kāi)

放平臺(tái)或者百度地圖的開(kāi)放平臺(tái)，找到地圖API，這樣的話我們只需要購(gòu)買?德的服務(wù)，部署調(diào)??德地圖API，這樣就可以快速在我們頁(yè)?上線

地圖功能了。

三、API接?的核?

對(duì)于????，初看API?檔可能是?頭霧?的——從哪?看，怎么看，看什么是擺在?前的問(wèn)題。

其實(shí)對(duì)于產(chǎn)品經(jīng)理??，我們應(yīng)該更關(guān)注這個(gè)公司可以提供什么樣的API接?服務(wù)，?如我知道?德可以提供地圖API，規(guī)劃路線的API，這樣的

話在我們?cè)O(shè)計(jì)功能和?作中就可以想到調(diào)?他們的服務(wù)或者參考。

所以產(chǎn)品??們看不懂也不?過(guò)于擔(dān)?，未來(lái)?作中你也會(huì)更深?了解清楚，因?yàn)榭炊⒉粡?fù)雜，以下是API接?的核?點(diǎn)，所有的說(shuō)明?檔離不

開(kāi)這5個(gè)核?點(diǎn)。

以下說(shuō)明均以微信開(kāi)放平臺(tái)為例說(shuō)明，?末有各開(kāi)放平臺(tái)的地址，?家有空可以去學(xué)習(xí)。好了，事不宜遲，現(xiàn)在我們來(lái)建??個(gè)場(chǎng)景。

我們現(xiàn)在有?個(gè)APP，需要?戶在購(gòu)買的時(shí)候調(diào)起微信?付的API，完成購(gòu)買。請(qǐng)各位?動(dòng)進(jìn)?這個(gè)場(chǎng)景，把??當(dāng)作?位產(chǎn)品經(jīng)理。

1.接?地址

現(xiàn)在Now，?戶點(diǎn)擊付款，我們需要告訴微信，我們要調(diào)起你們的收銀臺(tái)啦！但，去哪?告訴呢？這就需要接?地址了，也就相當(dāng)于向微信的這

條鏈接傳輸指定的數(shù)據(jù)。

?個(gè)鏈接地址不是我們理解的?個(gè)頁(yè)?，你可以理解是?個(gè)電話號(hào)碼，??們要改變這個(gè)觀念。

此時(shí)我們可以看到接??檔告訴我們鏈接是如下這條，那我們現(xiàn)在已經(jīng)撥通微信的電話了。

2.請(qǐng)求參數(shù)（報(bào)?）

我們現(xiàn)在需要告訴微信，你想調(diào)?收銀臺(tái)對(duì)吧。那我們需要寫(xiě)下來(lái)，此時(shí)?成的叫做報(bào)?，也就是你想告訴這個(gè)接?的內(nèi)容是什么？相當(dāng)于前?函

數(shù)的輸?x=2。

?般來(lái)說(shuō)，報(bào)?的格式和內(nèi)容都是按接??檔規(guī)定的。如下?就是微信開(kāi)放平臺(tái)對(duì)調(diào)起收銀臺(tái)的報(bào)?要求。

我們先來(lái)看前2個(gè)參數(shù)，你現(xiàn)在跟微信在對(duì)話，是不是應(yīng)該先告訴微信，你是誰(shuí)？這?微信的?檔告訴你應(yīng)該要?應(yīng)?ID+商戶號(hào)來(lái)確定你的?

份，什么意思呢？

?如你是A商戶，下?有a，b，c三個(gè)APP，所以微信要知道你是哪個(gè)商家，下?的哪個(gè)APP要?收銀臺(tái)。這是?常重要的，微信后?要把收到的

錢打到對(duì)應(yīng)的賬戶以及統(tǒng)計(jì)數(shù)據(jù)等。

那我們就在報(bào)???寫(xiě)下這兩句話：

wx2421b1c4370ec43b（我的應(yīng)?ID是wx2421…….）

10000100（我的商戶號(hào)是10000…….）

好了，現(xiàn)在微信知道你是誰(shuí)了，那你要告訴微信，你需要微信?付幫你收多少錢對(duì)吧？這?定義了貨幣類型和總?額，也就是收什么貨幣，收多少

錢。

這?你看，貨幣類型的必填寫(xiě)了否，也就是說(shuō)你也可以不告訴微信?付貨幣類型是什么，因?yàn)樗诤?備注了默認(rèn)是?民幣。

好的，那我們寫(xiě)下兩段報(bào)?

CNY（我要收?民幣）

1（我要收1元）

好了，現(xiàn)在微信知道你是誰(shuí)，也知道要收多少錢了，那接下來(lái)微信?付要把收錢結(jié)果告訴你呀，因?yàn)槟愕弥?戶是成功?付了才能繼續(xù)發(fā)貨，服

務(wù)啊等等的。所以這?我們?到通知地址，就是告訴微信，等下完事了他去哪?告訴你?付結(jié)果。那我們把地址寫(xiě)好：

3.返回結(jié)果

剛剛微信?付已經(jīng)去收款了，現(xiàn)在他要在我們留下的通知地址中，告訴我們結(jié)果了。結(jié)果??是兩種：成功收款？收款不成功？

（1）成功

很順利，現(xiàn)在?戶成功付錢了，并且微信也把成功的消息告訴我們了，并且他還把?戶?付的?些信息也告訴我們。

那這?就是微信?付成功收款后告訴我們的信息。

應(yīng)?APPID，商戶號(hào)：告訴你我成功扣款的是哪家商戶的哪個(gè)APPID的交易。

業(yè)務(wù)結(jié)果：成功或失敗

（2）失敗

在產(chǎn)品設(shè)計(jì)的時(shí)候，我們往往很關(guān)注失敗的情況，當(dāng)收款失敗的時(shí)候，微信同時(shí)會(huì)告訴你失敗的原因，如下圖很好理解，失敗的原因有很多很多

種，我們?cè)谠O(shè)計(jì)的時(shí)候往往要分析每種失敗的原因，為每個(gè)失敗的原因設(shè)計(jì)頁(yè)?和?戶提?，以確保?戶能理解。

以上就是API接?基本運(yùn)作模式的理解，下?我將繼續(xù)更新API接?的?些更為深?和細(xì)節(jié)的關(guān)鍵元素，如請(qǐng)求?式/簽名/加解密等等。

可供參考的開(kāi)放平臺(tái)?站