API接口設計 API設計原則



文章插圖
API接口設計 API設計原則

文章插圖
隨著各行各業的精細化發展,應用于各行各業的軟硬件系統也呈現專業化、垂直化的發展趨勢,一些業務場景極有可能需要多套系統配合來完成,那么系統之間進行集成對接,是擺在企事業單位及各類系統提供商必須解決的課題 。
呼叫中心行業也不例外,常見與CRM系統、ERP系統、OA系統及客戶的業務流程系統進行對接 。天天訊通經過多年的生產實踐,API接口相對完善,公共的API接口能滿足絕大多數業務場景 。但在實踐中,天天訊通發現不需要配合獨自完成對接的只占一小部分,更多的伙伴們需要廠家的技術支持配合聯調,甚至針對業務流程進行流程定制 。
那么,API接口到底該怎么設計才好呢?
一般情況下,絕大多數系統開發工程師,對API接口的關注點重心放在了功能實現上,因為功能實現是最容易理解的,對API對接的雙方均如此 ??简瀼S家的,并不是功能點實現,而是功能點的抽象設計是否合理,否則,一個伙伴一個功能點實現方式,多個伙伴將引入多種實現方式,長期看,維護開銷將是不可承受的 。
一般的,功能點之外,API接口設計比較容易被忽略的部分是可維護性設計,除接口的可維護性之外,還有對功能點的維護 。接口的可維護性,主要是體現在接口要設計前后兼容、擴展預留設計;功能點的維護,主要體現在維護特性,例如功能點的配置、增刪改查、日志及記錄文件的維護管理等,功能點的維護部分,開發工作量上可能成倍高于功能點設計,一般的,需要根據管理操作的頻度、開發代價等做出平衡 。
API接口相對較難的地方,主要是對于異常情況的處理;既要考慮業務流程的異常,還要考慮軟硬件環境、網絡傳輸、安全驗證等方面出現異常時進行合理的處理,而往往針對這些異常的處理又顯得十分必要,如果出現異常將導致經營上的不小損失,例如用于計費的話單出現重復或丟失,而這類問題,一種可能是網絡傳輸不可靠,其導致的關鍵數據出現重復、丟失時,如何在兩套系統同步信息,對雙邊系統都是一個考驗,特別是在業務繁忙的系統,處理方式的不同對系統的影響也將天差地別 。
除上述一些因素外,依據場景的不同,在實踐中往往還會對API接口的性能、安全等方面做出特別考慮,均需要做好設計,滿足場景需求 。
【API接口設計 API設計原則】在多年的生產實踐中,天天訊通在系統產品上對接過各行各業的多種業務系統,積累了豐富的API對接經驗,也將一如既往貼近使用場景,做好API設計,做好產品&服務 。