一個(gè)示例了解什么是 API 集成

API?集成?是一種代碼,它使一個(gè)系統(tǒng)能夠通過 API(應(yīng)用程序接口)安全地向另一個(gè)系統(tǒng)傳輸數(shù)據(jù)或從中獲取數(shù)據(jù)。某些?API 集成可能僅涉及一個(gè) API,而其他集成則可能涉及兩個(gè)或多個(gè) API。

API 集成通常分為兩類:

內(nèi)部集成: 旨在自動(dòng)化公司內(nèi)部的業(yè)務(wù)流程。

外部集成: 旨在連接來自不同公司的系統(tǒng),實(shí)現(xiàn)外部數(shù)據(jù)共享。

本文將以外部數(shù)據(jù)共享為例進(jìn)行說明,但這些概念也適用于內(nèi)部集成。示例將按以下順序展開:

集成業(yè)務(wù)需求(為什么): 解釋集成的目的和需要解決的問題。

集成技術(shù)要求(什么): 描述實(shí)現(xiàn)集成所需的技術(shù)規(guī)范和要求。

執(zhí)行的集成詳細(xì)信息(如何執(zhí)行): 詳細(xì)說明如何實(shí)現(xiàn)集成的步驟和方法。

集成業(yè)務(wù)需求

對(duì)于此 API 集成示例,您的公司提供了一個(gè)?SaaS?產(chǎn)品用于監(jiān)控建筑物安全性,定期記錄每個(gè)客戶建筑物關(guān)鍵點(diǎn)的傳感器的溫度和濕度水平。客戶需要一個(gè)集成方案,將這些溫度和濕度值每天導(dǎo)出到其建筑維護(hù)應(yīng)用程序(StructManager)。這樣,客戶可以分析這些數(shù)據(jù)與計(jì)劃外維護(hù)票證之間是否存在相關(guān)性。

集成技術(shù)要求

在構(gòu)建集成時(shí),技術(shù)要求是關(guān)鍵。需要回答以下問題:

數(shù)據(jù):前一天(24小時(shí)期間)每棟建筑物的濕度和溫度記錄。

方向:從您的產(chǎn)品單向?qū)С龅?StructManager。

頻率:每天早上 7 點(diǎn)(當(dāng)?shù)貢r(shí)間)運(yùn)行一次。

API:您的產(chǎn)品使用?SOAP?API,StructManager 使用 REST API。

協(xié)議:兩個(gè) API 都支持 HTTP。

語言:您的產(chǎn)品輸出?SOAP?XML,StructManager 接受 JSON 作為輸入。

身份驗(yàn)證:SOAP API?和 REST API 使用?OAuth。

此外,需要注意的是,濕度數(shù)據(jù)以百分比提供,溫度數(shù)據(jù)在您的產(chǎn)品中使用攝氏度,而 StructManager 使用華氏度。您的產(chǎn)品每分鐘收集一次數(shù)據(jù),而 StructManager 需要每 15 分鐘一次的數(shù)據(jù)。因此,這不僅僅是將數(shù)據(jù)從一個(gè) API 傳輸?shù)搅硪粋€(gè) API,還需要處理數(shù)據(jù)格式轉(zhuǎn)換和數(shù)據(jù)采樣頻率的調(diào)整。

執(zhí)行的集成詳細(xì)信息

在當(dāng)?shù)貢r(shí)間早上 7 點(diǎn),集成觸發(fā)器會(huì)向產(chǎn)品的 SOAP API 發(fā)送請(qǐng)求,查詢過去 24 小時(shí)內(nèi)每個(gè)建筑物的記錄。SOAP API 使用內(nèi)置的?OAuth?進(jìn)行身份驗(yàn)證,接收到請(qǐng)求后,通過 HTTP 以 XML 格式返回所有匹配的記錄。

單個(gè)記錄的 XML 示例:

AA8312

H265

1323

5W2NAB

10:30

27.3

55

集成首先將?XML?轉(zhuǎn)換為 JSON,單條記錄的 JSON 示例:

{

"environmental": {

"customer_id": "AA8312",

"building_id": "H265",

"sensor_id": 1323,

"sensor_loc": "5W2NAB",

"timestamp": "10:30",

"temperature": 27.3,

"humidity": 55

}

}

對(duì)于在一棟建筑物上有 30 個(gè)傳感器的示例客戶,每天從 SOAP API 導(dǎo)出的記錄總數(shù)為 43,200 條。集成需要篩選出 2,880 條記錄,保留符合特定時(shí)間戳(如 hh:00、hh:15、hh:30、hh:45)的記錄。雖然可以優(yōu)化 SOAP API 請(qǐng)求以僅獲取這些記錄,但從數(shù)據(jù)超集開始處理可能更清晰。

篩選后的數(shù)據(jù)集需要再次轉(zhuǎn)換,將攝氏度溫度值轉(zhuǎn)換為華氏度。轉(zhuǎn)換后的示例數(shù)據(jù)與 StructManager 所需的格式匹配:

{

"environmental": {

"customer_id": "AA8312",

"building_id": "H265",

"sensor_id": 1323,

"sensor_loc": "5W2NAB",

"timestamp": "10:30",

"temperature": 81.1,

"humidity": 55

}

}

最終,所有 2,880 條 JSON 編碼的記錄將通過 HTTP 請(qǐng)求發(fā)送到 StructManager REST API,并使用 OAuth 進(jìn)行身份驗(yàn)證。API 集成成功運(yùn)行,將在明天早上 7 點(diǎn)進(jìn)行下一次運(yùn)行。

其他 API 集成資源

當(dāng)然,一個(gè)例子很難公正地描述像 API 集成這樣復(fù)雜的主題??紤]到這一點(diǎn),這里有一些資源可以幫助進(jìn)一步理解 API 集成概念:

按技術(shù)分類的 API(如 REST、XML-RPC、SOAP 和?GraphQL)。

按訪問類型(私有、合作伙伴、公共和開放)劃分的 API。

集成傳輸協(xié)議和傳輸語言。

集成媒體類型(以前稱為 MIME 類型)。

集成過程中的具體操作。

總結(jié)

API 對(duì)于在 SaaS 產(chǎn)品之間構(gòu)建數(shù)據(jù)集成非常有幫助。然而,擁有正確的工具來處理這些 API 至關(guān)重要。作為一家提供應(yīng)用內(nèi)集成的軟件公司,使用這些工具可以在滿足客戶需求的最低限度集成和將集成無縫實(shí)施為 SaaS 產(chǎn)品的一部分之間,做出關(guān)鍵的區(qū)別,使客戶無法區(qū)分您的產(chǎn)品和集成的界限。嵌入式集成平臺(tái)就是其中一個(gè)重要工具。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容