系統(tǒng)型產(chǎn)品接口設(shè)計(jì)方法總結(jié)

5 評(píng)論 32460 瀏覽 322 收藏 7 分鐘

文章簡(jiǎn)單總結(jié)了接口設(shè)計(jì)的一些方法,希望能夠?qū)δ阌兴鶐椭?/p>

現(xiàn)在社會(huì)都在將談?wù)摗肮蚕怼?,很多我們接觸的APP中,要完成所有的業(yè)務(wù)流程多少都需要和第三方產(chǎn)品進(jìn)行對(duì)接,使用第三方已完成的功能。

舉個(gè)簡(jiǎn)單的例子:現(xiàn)在幾乎所有的APP注冊(cè)都是使用手機(jī)號(hào)進(jìn)行注冊(cè),為了驗(yàn)證手機(jī)號(hào)為操作人本人所使用,都會(huì)發(fā)送一條短信驗(yàn)證碼。這個(gè)時(shí)候,基本上發(fā)送短信的業(yè)務(wù)就使用到了第三方短信平臺(tái)來(lái)完成。所以作為產(chǎn)品經(jīng)理必須要了解,如何進(jìn)行對(duì)接,要傳什么信息給第三方平臺(tái),第三方平臺(tái)處理完成業(yè)務(wù)后,所返回的信息我們應(yīng)該如何處理等。

在此,我就簡(jiǎn)單的做個(gè)總結(jié),讓各位剛?cè)胄械漠a(chǎn)品經(jīng)理們知道如何進(jìn)行多系統(tǒng)對(duì)接。首先,從了解基本名稱出發(fā);其次,了解設(shè)計(jì)的方法;最后案例解說(shuō)加深大家的理解。

一、了解名詞及作用

1.?? 名詞解釋

  • 軟件接口:程序組件間對(duì)接的出入口。
  • 頁(yè)面跳轉(zhuǎn)同步通知:如果一個(gè)進(jìn)程在執(zhí)行請(qǐng)求時(shí),該請(qǐng)求需要一段時(shí)間才能返回信息,那么這個(gè)進(jìn)程就會(huì)一直等待下去。通俗點(diǎn)就是有先后順序,必須先完成前面事務(wù)才能做后面事務(wù)。
  • 異步通知:進(jìn)程不用等待可以繼續(xù)執(zhí)行下面的操作。背后信息傳輸,不分先后。

2.?? 接口作用

由架構(gòu)師將整個(gè)系統(tǒng)架構(gòu)搭建出來(lái),各個(gè)子系統(tǒng)或者各個(gè)模塊之間通過(guò)接口進(jìn)行調(diào)用,可以讓整個(gè)系統(tǒng)拓展性增強(qiáng)。

各個(gè)子系統(tǒng)或各模塊之間信息傳輸必須要進(jìn)行一定的安全驗(yàn)證,保證信息傳輸?shù)恼_性。

3.?? 接口的組成

接口常常成對(duì)出現(xiàn),有請(qǐng)求參數(shù)和返回參數(shù)。

請(qǐng)求接口一般必須包括兩個(gè)部分:基本參數(shù)、業(yè)務(wù)參數(shù)

  • 基本參數(shù):接口名稱、身份認(rèn)證參數(shù)(即對(duì)接的模塊或系統(tǒng)ID、簽名、密鑰等)
  • 業(yè)務(wù)參數(shù):該接口所有提供的服務(wù)或者所要達(dá)到目標(biāo)的業(yè)務(wù)信息。

4.?? 同步、異步一般傳值情況

同步:主要作用于頁(yè)面跳轉(zhuǎn),傳值信息主要將頁(yè)面所要處理的最關(guān)鍵信息傳輸即可。

異步:是為了強(qiáng)調(diào)給對(duì)接的模塊處理業(yè)務(wù)信息,傳值信息根據(jù)實(shí)際情況盡可能詳細(xì)一些,但是必須和本接口設(shè)計(jì)的目標(biāo)一致,不要傳輸太多無(wú)用的參數(shù)。

二、設(shè)計(jì)的方法及選擇

1.?? 接口設(shè)計(jì)的方法

第一種:外部調(diào)用方call本系統(tǒng)的接口,同步返回請(qǐng)求成功,但實(shí)際操作是本系統(tǒng)延后去執(zhí)行的,異步返回處理結(jié)果。

  • 發(fā)起方:用戶
  • 優(yōu)點(diǎn):外部調(diào)用方不需要等待業(yè)務(wù)處理結(jié)果,可以進(jìn)行自身其實(shí)業(yè)務(wù)處理。
  • 不足:當(dāng)外部調(diào)用方未能及時(shí)處理異步通知結(jié)果時(shí),有可能會(huì)導(dǎo)致自身業(yè)務(wù)會(huì)存在一些風(fēng)險(xiǎn)或用戶體驗(yàn)度不足。為減輕不足之處,此方式的接口設(shè)計(jì),需要另外再設(shè)計(jì)一個(gè)查詢業(yè)務(wù)處理結(jié)果的接口。

1

第二種:外部調(diào)用方call本系統(tǒng)的接口,業(yè)務(wù)處理完成后直接返回處理結(jié)果。

  • 發(fā)起方:商戶/外部調(diào)用方
  • 優(yōu)點(diǎn):外部調(diào)用方必須等到本系統(tǒng)業(yè)務(wù)處理完成后才能繼續(xù)進(jìn)行自身系統(tǒng)的業(yè)務(wù),可以避免存在遺漏的業(yè)務(wù)未處理。
  • 缺點(diǎn):外部調(diào)用方必須等待業(yè)務(wù)處理結(jié)果,前臺(tái)用戶也會(huì)看到等待頁(yè)面,增加了用戶的焦躁感。

2

2.?? 接口設(shè)計(jì)方式的選擇

接口要為需求服務(wù),在接口設(shè)計(jì)時(shí)的思考步驟:

  1. 回歸產(chǎn)品的最初定位
  2. 設(shè)想業(yè)務(wù)場(chǎng)景,選擇最優(yōu)的用戶體驗(yàn)方式。
  3. 根據(jù)最優(yōu)的用戶體驗(yàn)方式繪制業(yè)務(wù)流程。

3.?? 示例-廣電公共賬戶充值

3.1.需求描述

  • 為SP提供廣電公共賬戶充值服務(wù),該服務(wù)屬于獨(dú)立的功能模塊。
  • 用戶進(jìn)行業(yè)務(wù)訂購(gòu),當(dāng)公共賬戶余額不足時(shí),需要充值賬戶余額后進(jìn)行訂購(gòu)。

3.2.分析思路

1.定位:充值服務(wù)、獨(dú)立功能模塊。

2.場(chǎng)景設(shè)想:

3.場(chǎng)景選擇:通過(guò)以上場(chǎng)景設(shè)想描述分析得出,場(chǎng)景二對(duì)于用戶來(lái)說(shuō)操作步驟會(huì)比較簡(jiǎn)單,可以最快的達(dá)到最初的需求目標(biāo)。

4.接口設(shè)計(jì)方式選擇:第二種方式

3.3.繪制業(yè)務(wù)流程

3

總結(jié)

在進(jìn)行多產(chǎn)品系統(tǒng)對(duì)接時(shí),在接口設(shè)計(jì)方法各有優(yōu)劣勢(shì),采用何種方法進(jìn)行設(shè)計(jì)最終還得回歸到產(chǎn)品的特性,需考慮到產(chǎn)品運(yùn)行的環(huán)境、產(chǎn)品定位、使用場(chǎng)景、團(tuán)隊(duì)技術(shù)水平情況等多方面考慮,去選擇合適自身產(chǎn)品的方法。

 

作者:嵐天,一位從前端開發(fā)轉(zhuǎn)入產(chǎn)品崗的初級(jí)產(chǎn)品經(jīng)理

本文由 @嵐天 原創(chuàng)發(fā)布于人人都是產(chǎn)品經(jīng)理。未經(jīng)許可,禁止轉(zhuǎn)載。

題圖來(lái)自PEXELS,基于CC0協(xié)議

更多精彩內(nèi)容,請(qǐng)關(guān)注人人都是產(chǎn)品經(jīng)理微信公眾號(hào)或下載App
評(píng)論
評(píng)論請(qǐng)登錄
  1. 3.3繪制業(yè)務(wù)流程中
    表述可能不準(zhǔn)確,支付處理這一段,應(yīng)該是從SP和樂(lè)眾支付之間的調(diào)用返回?
    不知道這樣理解準(zhǔn)確嗎

    來(lái)自上海 回復(fù)
  2. 產(chǎn)品經(jīng)理搞接口就是不歸路,提好需求,丟給架構(gòu)師吧。不然搞到最后,產(chǎn)品寫的都是接口文檔,架構(gòu)師在笑。

    回復(fù)
    1. 不能同意更多,之前去傳統(tǒng)企業(yè)給移動(dòng)做系統(tǒng),妹的,北京總部的產(chǎn)品只做業(yè)務(wù)描述,我們成都的產(chǎn)品還要弄接口文檔,用戶自己業(yè)務(wù)都不確定,傳統(tǒng)軟件企業(yè)真是該被淘汰,產(chǎn)品界面丑,交互復(fù)雜,一點(diǎn)都不考慮用戶體驗(yàn),只為項(xiàng)目驗(yàn)收,而項(xiàng)目就是為了給領(lǐng)導(dǎo)看,實(shí)際都不用的功能。

      來(lái)自四川 回復(fù)
    2. 同意,深有感受!

      來(lái)自上海 回復(fù)
  3. 實(shí)用!

    回復(fù)